openapi: 3.0.0
info:
    title: OpenEMIS Core
    description: |-
        The [OpenEMIS](https://www.openemis.org/) initiative aims to deploy a high-quality Education Management Information System (EMIS) designed to collect and report data on schools, students, teachers and staff. The system was conceived by `UNESCO` to be a royalty-free system that can be easily customized to meet the specific needs of member countries.
    termsOfService: https://www.openemis.org/terms-of-service/
    contact:
        email: support@openemis.org
    license:
        name: GNU General Public License V3.0
        url: https://www.gnu.org/licenses/gpl-3.0.en.html
    version: 4.0.0
servers:
    - url: https://demo.openemis.org/core
tags:
    - name: User Authentication
      description: APIs for User Authentication
    - name: Academic Periods
      description: APIs for Academic Periods
    - name: Education Structure Details
      description: APIs for Education Structure Details
    - name: Institutions
      description: APIs for Institutions
    - name: Institution Grades
      description: APIs for Institution Grades
    - name: Institution Classes
      description: APIs for Institution Classes
    - name: Institution Subjects
      description: APIs for Institution Subjects
    - name: Institution Shifts
      description: APIs for Institution Shifts
    - name: Institution Areas
      description: APIs for Institution Areas
    - name: Institution Summary
      description: APIs for Institution Summary
    - name: Institution Grade Summary
      description: APIs for Institution Grade Summary
    - name: Institution Room Type Summary
      description: APIs for Institution Room Type Summary
    - name: Institution Student Nationality Summary
      description: APIs for Institution Student Nationality Summary
    - name: User Details
      description: APIs for User Details
    - name: Institution Staff
      description: APIs for Institution Staff
    - name: Institution Positions
      description: APIs for Institution Positions
    - name: Locale Content Details
      description: APIs for Locale Content Details
    - name: Textbook Details
      description: APIs for Textbooks
    #POCOR-7394-S starts
    - name: Institution students
      description: APIs for Institution students Details
    - name: Meals
      description: APIs for Meals Details
    #POCOR-7394-S ends
    #POCOR-7546 starts
    - name: Assessments
      description: APIs for Assessments Details
    #POCOR-7546 ends

paths:
    /api/v4/login:
        post:
            tags:
                - User Authentication
            summary: Login
            description: Login
            operationId: User Authentication
            parameters:
                - name: username
                  in: query
                  description: The user name for login
                  required: true
                  schema:
                      type: string
                - name: password
                  in: query
                  description: The password for login in clear text
                  required: true
                  schema:
                      type: string
                - name: api_key
                  in: query
                  description: The api_key that is configured
                  required: true
                  schema:
                      type: string
            responses:
                "200":
                    description: Successful operation
                    content:
                        application/json:
                            schema:
                                $ref: "#/components/schemas/login"
                        application/xml:
                            schema:
                                $ref: "#/components/schemas/login"
                "404":
                    description: Invalid Email or Password
                "500":
                    description: Invalid Username

    /api/v4/otp-generate:
        post:
            tags:
                - User Authentication
            summary: Generate OTP
            description: API to Generate OTP
            operationId: Generate OTP
            parameters:
                - name: email
                  in: query
                  description: The email address
                  required: true
                  schema:
                      type: string
            responses:
                "200":
                    description: Successful operation
                "404":
                    description: Invalid Email

    /api/v4/otp-verify:
        post:
            tags:
                - User Authentication
            summary: Verify OTP
            description: API to Verify OTP
            operationId: Verify OTP
            parameters:
                - name: One Time Password
                  in: query
                  description: The One Time Password
                  required: true
                  schema:
                      type: string
            responses:
                "200":
                    description: Successful operation
                "404":
                    description: Invalid OTP

    #For POCOR-8206 Start
    /api/v4/academic-periods/list:
        get:
            tags:
                - Academic Periods
            summary: Get current Academic Period
            description: Get current Academic Period
            responses:
                "200":
                    description: successful
                    content:
                        application/json:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Academic-Periods-List"
                "400":
                    description: Something went wrong.

    /api/v4/academic-periods:
        get:
            tags:
                - Academic Periods
            summary: Get Academic Period List
            description: This API gives the list of All academic periods.
            responses:
                "200":
                    description: successful
                    content:
                        application/json:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Academic-Periods"
                "400":
                    description: Something went wrong.
    #For POCOR-8206 End

    /api/v4/systems/levels/cycles/programmes/grades/list:
        get:
            tags:
                - Education Structure Details
            summary: Get Current Grades
            description: Multiple values can be provided with comma separated strings
            parameters:
                - name: academic_period_id
                  in: query
                  description: This is to filter the results based on the academic_period_id
                  required: false
                  schema:
                      type: integer
            responses:
                "200":
                    description: successful operation
                "400":
                    description: Invalid status value

    /api/v4/systems/levels/cycles/programmes/grades/subjects:
        get:
            tags:
                - Education Structure Details
            summary: Get All Grade Subjects
            description: Multiple values can be provided with comma separated strings
            parameters:
                - name: academic_period_id
                  in: query
                  description: This is to filter the results based on the academic_period_id
                  required: false
                  schema:
                      type: integer
                - name: limit
                  in: header
                  description: This is to limit the number of result
                  required: false
                  schema:
                      type: integer
                - name: order
                  in: header
                  description: This is to sort the results
                  required: false
                  schema:
                      type: string
                - name: page
                  in: header
                  description: This is to display the results based on the page number
                  required: false
                  schema:
                      type: integer
            responses:
                "200":
                    description: successful operation
                    content:
                        application/json:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Education-System"
                        application/xml:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Education-System"
                "400":
                    description: Invalid status value

    /api/v4/systems/{system_id}/levels/cycles/programmes/grades/subjects:
        get:
            tags:
                - Education Structure Details
            summary: Get All Grade Subjects
            description: Multiple values can be provided with comma separated strings
            parameters:
                - name: academic_period_id
                  in: query
                  description: This is to filter the results based on the academic_period_id
                  required: false
                  schema:
                      type: integer
                - name: limit
                  in: header
                  description: This is to limit the number of result
                  required: false
                  schema:
                      type: integer
                - name: order
                  in: header
                  description: This is to sort the results
                  required: false
                  schema:
                      type: string
                - name: page
                  in: header
                  description: This is to display the results based on the page number
                  required: false
                  schema:
                      type: integer
                - name: system_id
                  in: path
                  description: The level id
                  required: true
                  schema:
                      type: integer
            responses:
                "200":
                    description: successful operation
                    content:
                        application/json:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Education-System"
                        application/xml:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Education-System"
                "400":
                    description: Invalid status value

    /api/v4/systems/{system_id}/levels/{level_id}/cycles/programmes/grades/subjects:
        get:
            tags:
                - Education Structure Details
            summary: Get All Grade Subjects
            description: Multiple values can be provided with comma separated strings
            parameters:
                - name: academic_period_id
                  in: query
                  description: This is to filter the results based on the academic_period_id
                  required: false
                  schema:
                      type: integer
                - name: limit
                  in: header
                  description: This is to limit the number of result
                  required: false
                  schema:
                      type: integer
                - name: order
                  in: header
                  description: This is to sort the results
                  required: false
                  schema:
                      type: string
                - name: page
                  in: header
                  description: This is to display the results based on the page number
                  required: false
                  schema:
                      type: integer
                - name: system_id
                  in: path
                  description: The level id
                  required: true
                  schema:
                      type: integer
                - name: level_id
                  in: path
                  description: The level id
                  required: true
                  schema:
                      type: integer
            responses:
                "200":
                    description: successful operation
                    content:
                        application/json:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Education-System"
                        application/xml:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Education-System"
                "400":
                    description: Invalid status value

    /api/v4/systems/{system_id}/levels/{level_id}/cycles/{cycle_id}/programmes/{programme_id}/grades/subjects:
        get:
            tags:
                - Education Structure Details
            summary: Get All Grade Subjects
            description: Multiple values can be provided with comma separated strings
            parameters:
                - name: academic_period_id
                  in: query
                  description: This is to filter the results based on the academic_period_id
                  required: false
                  schema:
                      type: integer
                - name: limit
                  in: header
                  description: This is to limit the number of result
                  required: false
                  schema:
                      type: integer
                - name: order
                  in: header
                  description: This is to sort the results
                  required: false
                  schema:
                      type: string
                - name: page
                  in: header
                  description: This is to display the results based on the page number
                  required: false
                  schema:
                      type: integer
                - name: system_id
                  in: path
                  description: The level id
                  required: true
                  schema:
                      type: integer
                - name: level_id
                  in: path
                  description: education_level_id
                  required: true
                  schema:
                      type: integer
                - name: cycle_id
                  in: path
                  description: education_cycle_id
                  required: true
                  schema:
                      type: integer
                - name: programme_id
                  in: path
                  description: education_programme_id
                  required: true
                  schema:
                      type: integer
            responses:
                "200":
                    description: successful operation
                    content:
                        application/json:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Education-System"
                        application/xml:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Education-System"
                "400":
                    description: Invalid status value

    /api/v4/systems/{system_id}/levels/{level_id}/cycles/{cycle_id}/programmes/{programme_id}/grades/{grade_id}/subjects:
        get:
            tags:
                - Education Structure Details
            summary: Get All Grade Subjects
            description: Multiple values can be provided with comma separated strings
            parameters:
                - name: academic_period_id
                  in: query
                  description: This is to filter the results based on the academic_period_id
                  required: false
                  schema:
                      type: integer
                - name: limit
                  in: header
                  description: This is to limit the number of result
                  required: false
                  schema:
                      type: integer
                - name: order
                  in: header
                  description: This is to sort the results
                  required: false
                  schema:
                      type: string
                - name: page
                  in: header
                  description: This is to display the results based on the page number
                  required: false
                  schema:
                      type: integer
                - name: system_id
                  in: path
                  description: The level id
                  required: true
                  schema:
                      type: integer
                - name: level_id
                  in: path
                  description: education_level_id
                  required: true
                  schema:
                      type: integer
                - name: cycle_id
                  in: path
                  description: education_cycle_id
                  required: true
                  schema:
                      type: integer
                - name: programme_id
                  in: path
                  description: education_programme_id
                  required: true
                  schema:
                      type: integer
                - name: grade_id
                  in: path
                  description: education_grade_id
                  required: true
                  schema:
                      type: integer
            responses:
                "200":
                    description: successful operation
                    content:
                        application/json:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Education-System"
                        application/xml:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Education-System"
                "400":
                    description: Invalid status value

    /api/v4/systems/{system_id}/levels/{level_id}/cycles/{cycle_id}/programmes/{programme_id}/grades/{grade_id}/subjects/{subject_id}:
        get:
            tags:
                - Education Structure Details
            summary: Get All Grade Subjects
            description: Multiple values can be provided with comma separated strings
            parameters:
                - name: academic_period_id
                  in: query
                  description: This is to filter the results based on the academic_period_id
                  required: false
                  schema:
                      type: integer
                - name: limit
                  in: header
                  description: This is to limit the number of result
                  required: false
                  schema:
                      type: integer
                - name: order
                  in: header
                  description: This is to sort the results
                  required: false
                  schema:
                      type: string
                - name: page
                  in: header
                  description: This is to display the results based on the page number
                  required: false
                  schema:
                      type: integer
                - name: system_id
                  in: path
                  description: The level id
                  required: true
                  schema:
                      type: integer
                - name: level_id
                  in: path
                  description: education_level_id
                  required: true
                  schema:
                      type: integer
                - name: cycle_id
                  in: path
                  description: education_cycle_id
                  required: true
                  schema:
                      type: integer
                - name: programme_id
                  in: path
                  description: education_programme_id
                  required: true
                  schema:
                      type: integer
                - name: grade_id
                  in: path
                  description: education_grade_id
                  required: true
                  schema:
                      type: integer
                - name: subject_id
                  in: path
                  description: education_subject_id
                  required: true
                  schema:
                      type: integer
            responses:
                "200":
                    description: successful operation
                    content:
                        application/json:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Education-System"
                        application/xml:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Education-System"
                "400":
                    description: Invalid status value

    /api/v4/institutions:
        get:
            tags:
                - Institutions
            summary: Get All Institutions
            description: Multiple Institution Details will be provided with comma separated strings
            parameters:
                - name: academic_period_id
                  in: query
                  description: This is to filter the results based on the academic_period_id
                  required: false
                  schema:
                      type: integer
                - name: limit
                  in: header
                  description: This is to limit the number of result
                  required: false
                  schema:
                      type: integer
                - name: order
                  in: header
                  description: This is to sort the results
                  required: false
                  schema:
                      type: string
                - name: page
                  in: header
                  description: This is to display the results based on the page number
                  required: false
                  schema:
                      type: integer
            responses:
                "200":
                    description: successful operation
                    content:
                        application/json:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Institutions"
                        application/xml:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Institutions"
                "400":
                    description: Invalid status value

    /api/v4/institutions/{institutionId}:
        get:
            tags:
                - Institutions
            summary: Get Institution by Institution ID
            description: Multiple status values can be provided with comma separated strings
            operationId: institutionId
            parameters:
                - name: academic_period_id
                  in: query
                  description: This is to filter the results based on the academic_period_id
                  required: false
                  schema:
                      type: integer
                - name: limit
                  in: header
                  description: This is to limit the number of result
                  required: false
                  schema:
                      type: integer
                - name: order
                  in: header
                  description: This is to sort the results
                  required: false
                  schema:
                      type: string
                - name: page
                  in: header
                  description: This is to display the results based on the page number
                  required: false
                  schema:
                      type: integer
                - name: institutionId
                  in: path
                  description: Add Institution id to filter
                  required: true
                  schema:
                      type: integer
                      format: int
            responses:
                "200":
                    description: successful operation
                    content:
                        application/json:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Institutions"
                        application/xml:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Institutions"
                "400":
                    description: Invalid status value

    /api/v4/institutions/list:
        get:
            tags:
                - Institutions
            summary: Get List of Institutions
            description: Multiple Institution Details will be provided with comma separated strings
            responses:
                "200":
                    description: successful operation
                "400":
                    description: Invalid status value

    /api/v4/institutions/areas/list:
        get:
            tags:
                - Institutions
            summary: Get Areas from Institutions
            description: Multiple Details will be provided with comma separated strings
            responses:
                "200":
                    description: successful operation
                "400":
                    description: Invalid status value

    /api/v4/institutions/grades:
        get:
            tags:
                - Institution Grades
            summary: Get All Institution Grades
            description: Multiple values can be provided with comma separated strings
            operationId: getallinstitutiongrades
            parameters:
                - name: academic_period_id
                  in: query
                  description: This is to filter the results based on the academic_period_id
                  required: false
                  schema:
                      type: integer
                - name: limit
                  in: header
                  description: This is to limit the number of result
                  required: false
                  schema:
                      type: integer
                - name: order
                  in: header
                  description: This is to sort the results
                  required: false
                  schema:
                      type: string
                - name: page
                  in: header
                  description: This is to display the results based on the page number
                  required: false
                  schema:
                      type: integer
            responses:
                "200":
                    description: successful operation
                    content:
                        application/json:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Institution-Grades"
                        application/xml:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Institution-Grades"
                "400":
                    description: Invalid status value

    /api/v4/institutions/{institutionId}/grades:
        get:
            tags:
                - Institution Grades
            summary: Get All Grades for one Institution
            description: Multiple grades can be provided with comma separated strings
            parameters:
                - name: academic_period_id
                  in: query
                  description: This is to filter the results based on the academic_period_id
                  required: false
                  schema:
                      type: integer
                - name: limit
                  in: header
                  description: This is to limit the number of result
                  required: false
                  schema:
                      type: integer
                - name: order
                  in: header
                  description: This is to sort the results
                  required: false
                  schema:
                      type: string
                - name: page
                  in: header
                  description: This is to display the results based on the page number
                  required: false
                  schema:
                      type: integer
                - name: institutionId
                  in: path
                  description: Add Institution id to filter
                  required: true
                  schema:
                      type: integer
                      format: int
            responses:
                "200":
                    description: successful operation
                    content:
                        application/json:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Institution-Grades"
                        application/xml:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Institution-Grades"
                "400":
                    description: Invalid status value

    /api/v4/institutions/{institutionId}/grades/{gradeId}:
        get:
            tags:
                - Institution Grades
            summary: Get All Grades for one Institution
            description: Multiple grades can be provided with comma separated strings
            parameters:
                - name: academic_period_id
                  in: query
                  description: This is to filter the results based on the academic_period_id
                  required: false
                  schema:
                      type: integer
                - name: limit
                  in: header
                  description: This is to limit the number of result
                  required: false
                  schema:
                      type: integer
                - name: order
                  in: header
                  description: This is to sort the results
                  required: false
                  schema:
                      type: string
                - name: page
                  in: header
                  description: This is to display the results based on the page number
                  required: false
                  schema:
                      type: integer
                - name: institutionId
                  in: path
                  description: Add Institution id to filter
                  required: true
                  schema:
                      type: integer
                      format: int
                - name: gradeId
                  in: path
                  description: Add grade id to filter
                  required: true
                  schema:
                      type: integer
                      format: int
            responses:
                "200":
                    description: successful operation
                    content:
                        application/json:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Institution-Grades"
                        application/xml:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Institution-Grades"
                "400":
                    description: Invalid status value

    /api/v4/institutions/classes:
        get:
            tags:
                - Institution Classes
            summary: Get all class for all Institution
            description: Multiple classes can be provided with comma separated strings
            parameters:
                - name: academic_period_id
                  in: query
                  description: This is to filter the results based on the academic_period_id
                  required: false
                  schema:
                      type: integer
                - name: limit
                  in: header
                  description: This is to limit the number of result
                  required: false
                  schema:
                      type: integer
                - name: order
                  in: header
                  description: This is to sort the results
                  required: false
                  schema:
                      type: string
                - name: page
                  in: header
                  description: This is to display the results based on the page number
                  required: false
                  schema:
                      type: integer
            responses:
                "200":
                    description: successful operation
                    content:
                        application/json:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Institution-Classes"
                        application/xml:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Institution-Classes"
                "400":
                    description: Invalid status value

    /api/v4/institutions/{institutionId}/classes:
        get:
            tags:
                - Student Attendance
            summary: Get All class for one Institution
            description: Multiple values can be provided with comma separated strings
            parameters:
                - name: academic_period_id
                  in: query
                  description: This is to filter the results based on the academic_period_id
                  required: false
                  schema:
                      type: integer
                - name: limit
                  in: header
                  description: This is to limit the number of result
                  required: false
                  schema:
                      type: integer
                - name: order
                  in: header
                  description: This is to sort the results
                  required: false
                  schema:
                      type: string
                - name: page
                  in: header
                  description: This is to display the results based on the page number
                  required: false
                  schema:
                      type: integer
                - name: institutionId
                  in: path
                  description: Add Institution id to filter
                  required: true
                  schema:
                      type: integer
                      format: int
            responses:
                "200":
                    description: successful operation
                    content:
                        application/json:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Institution-Classes"
                        application/xml:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Institution-Classes"
                "400":
                    description: Invalid status value

    /api/v4/institutions/{institutionId}/classes/{classId}:
        get:
            tags:
                - Institution Classes
            summary: Get one class for one Institution
            description: Multiple values can be provided with comma separated strings
            parameters:
                - name: academic_period_id
                  in: query
                  description: This is to filter the results based on the academic_period_id
                  required: false
                  schema:
                      type: integer
                - name: limit
                  in: header
                  description: This is to limit the number of result
                  required: false
                  schema:
                      type: integer
                - name: order
                  in: header
                  description: This is to sort the results
                  required: false
                  schema:
                      type: string
                - name: page
                  in: header
                  description: This is to display the results based on the page number
                  required: false
                  schema:
                      type: integer
                - name: institutionId
                  in: path
                  description: Add Institution id to filter
                  required: true
                  schema:
                      type: integer
                      format: int
                - name: classId
                  in: path
                  description: Add class id to filter
                  required: true
                  schema:
                      type: integer
                      format: int
            responses:
                "200":
                    description: successful operation
                    content:
                        application/json:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Institution-Classes"
                        application/xml:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Institution-Classes"
                "400":
                    description: Invalid status value

        post:
            tags:
                - Institution Classes
            summary: Update class of institution
            parameters:
                - name: institutionId
                  in: path
                  description: The ID of the institution.
                  required: true
                  schema:
                      type: integer
                - name: classId
                  in: path
                  description: The ID of the class.
                  required: true
                  schema:
                      type: integer
            requestBody:
                required: true
                content:
                    application/json:
                        schema:
                            type: object
                            properties:
                                name:
                                    type: string
                                    description: The name of the class.
                                    example: test
                                staff_id:
                                    type: integer
                                    description: The ID of the staff member.
                                    example: 345
                                institution_shift_id:
                                    type: integer
                                    description: The ID of the institution shift.
                                    example: 456
                                institution_unit_id:
                                    type: integer
                                    nullable: true
                                    description: The ID of the institution unit.
                                    example: null
                                institution_course_id:
                                    type: integer
                                    nullable: true
                                    example: null
                                    description: The ID of the institution course.
                                class_students:
                                    type: array
                                    items:
                                        type: object
                                        properties:
                                            student_id:
                                                type: integer
                                                description: The ID of the student.
                                                example: 456
                                            education_grade_id:
                                                type: integer
                                                description: The ID of the education grade.
                                                example: 1
                                academic_period_id:
                                    type: integer
                                    description: The ID of the academic period.
                                    example: 1
                                capacity:
                                    type: integer
                                    description: The capacity of the class.
                                    example: 16
                                classes_secondary_staff:
                                    type: array
                                    description: The ID of the secondary staff member.
                                    example: [144, 145]
                                    items:
                                        type: integer
            responses:
                "200":
                    description: Class updated successfully.
                "404":
                    description: Class not updated.

    /api/v4/institutions/subjects:
        get:
            tags:
                - Institution Subjects
            summary: Get All Subjects for All Institution
            description: Multiple values can be provided with comma separated strings
            parameters:
                - name: academic_period_id
                  in: query
                  description: This is to filter the results based on the academic_period_id
                  required: false
                  schema:
                      type: integer
                - name: limit
                  in: header
                  description: This is to limit the number of result
                  required: false
                  schema:
                      type: integer
                - name: order
                  in: header
                  description: This is to sort the results
                  required: false
                  schema:
                      type: string
                - name: page
                  in: header
                  description: This is to display the results based on the page number
                  required: false
                  schema:
                      type: integer
            responses:
                "200":
                    description: successful operation
                    content:
                        application/json:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Institution-Subjects"
                        application/xml:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Institution-Subjects"
                "400":
                    description: Invalid status value

    /api/v4/institutions/{institutionId}/subjects:
        get:
            tags:
                - Institution Subjects
            summary: Get All subjects for one Institution
            description: Multiple values can be provided with comma separated strings
            parameters:
                - name: academic_period_id
                  in: query
                  description: This is to filter the results based on the academic_period_id
                  required: false
                  schema:
                      type: integer
                - name: limit
                  in: header
                  description: This is to limit the number of result
                  required: false
                  schema:
                      type: integer
                - name: order
                  in: header
                  description: This is to sort the results
                  required: false
                  schema:
                      type: string
                - name: page
                  in: header
                  description: This is to display the results based on the page number
                  required: false
                  schema:
                      type: integer
                - name: institutionId
                  in: path
                  description: Add Institution id to filter
                  required: true
                  schema:
                      type: integer
                      format: int
            responses:
                "200":
                    description: successful operation
                    content:
                        application/json:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Institution-Subjects"
                        application/xml:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Institution-Subjects"
                "400":
                    description: Invalid status value

    /api/v4/institutions/{institutionId}/subjects/{subjectId}:
        get:
            tags:
                - Institution Subjects
            summary: Get All Grades for one Institution
            description: Multiple values can be provided with comma separated strings
            parameters:
                - name: academic_period_id
                  in: query
                  description: This is to filter the results based on the academic_period_id
                  required: false
                  schema:
                      type: integer
                - name: limit
                  in: header
                  description: This is to limit the number of result
                  required: false
                  schema:
                      type: integer
                - name: order
                  in: header
                  description: This is to sort the results
                  required: false
                  schema:
                      type: string
                - name: page
                  in: header
                  description: This is to display the results based on the page number
                  required: false
                  schema:
                      type: integer
                - name: institutionId
                  in: path
                  description: Add Institution id to filter
                  required: true
                  schema:
                      type: integer
                      format: int
                - name: subjectId
                  in: path
                  description: Add subject id to filter
                  required: true
                  schema:
                      type: integer
                      format: int
            responses:
                "200":
                    description: successful operation
                    content:
                        application/json:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Institution-Subjects"
                        application/xml:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Institution-Subjects"
                "400":
                    description: Invalid status value

        post:
            tags:
                - Institution Subjects
            summary: Update insititution subject by id
            parameters:
                - name: institutionId
                  in: path
                  description: The ID of the institution.
                  required: true
                  schema:
                      type: integer
                - name: subjectId
                  in: path
                  description: The ID of the subject.
                  required: true
                  schema:
                      type: integer
            requestBody:
                required: true
                content:
                    application/json:
                        schema:
                            type: object
                            properties:
                                name:
                                    type: string
                                    description: The name of the subject.
                                subject_students:
                                    type: array
                                    items:
                                        type: object
                                        properties:
                                            student_id:
                                                type: integer
                                                description: The ID of the student.
                                                example: 156
                                            institution_class_id:
                                                type: integer
                                                description: The ID of the institution class.
                                                example: 132
                                academic_period_id:
                                    type: integer
                                    description: The ID of the academic period.
                                    example: 1
                                subject_staff:
                                    type: array
                                    description: List of staff (if applicable).
                                    example: [34, 56]
                                    items:
                                        type: integer
                                classes:
                                    type: array
                                    description: List of Classes.
                                    example: [34, 56]
                                    items:
                                        type: integer
                                rooms:
                                    type: array
                                    description: List of rooms (if applicable).
                                    example: [34, 56]
                                    items:
                                        type: integer
                            required:
                                - id
                                - name
            responses:
                "200":
                    description: Subject updated successfully.
                "404":
                    description: Subject not updated..

    /api/v4/institutions/shifts:
        get:
            tags:
                - Institution Shifts
            summary: Get All Shifts for All Institution
            description: Multiple values can be provided with comma separated strings
            parameters:
                - name: academic_period_id
                  in: query
                  description: This is to filter the results based on the academic_period_id
                  required: false
                  schema:
                      type: integer
                - name: limit
                  in: header
                  description: This is to limit the number of result
                  required: false
                  schema:
                      type: integer
                - name: order
                  in: header
                  description: This is to sort the results
                  required: false
                  schema:
                      type: string
                - name: page
                  in: header
                  description: This is to display the results based on the page number
                  required: false
                  schema:
                      type: integer
            responses:
                "200":
                    description: successful operation
                    content:
                        application/json:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Institution-Shifts"
                        application/xml:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Institution-Shifts"
                "400":
                    description: Invalid status value

    /api/v4/institutions/{institutionId}/shifts:
        get:
            tags:
                - Institution Shifts
            summary: Get All Shifts for one Institution
            description: Multiple values can be provided with comma separated strings
            parameters:
                - name: academic_period_id
                  in: query
                  description: This is to filter the results based on the academic_period_id
                  required: false
                  schema:
                      type: integer
                - name: limit
                  in: header
                  description: This is to limit the number of result
                  required: false
                  schema:
                      type: integer
                - name: order
                  in: header
                  description: This is to sort the results
                  required: false
                  schema:
                      type: string
                - name: page
                  in: header
                  description: This is to display the results based on the page number
                  required: false
                  schema:
                      type: integer
                - name: institutionId
                  in: path
                  description: Add Institution id to filter
                  required: true
                  schema:
                      type: integer
                      format: int
            responses:
                "200":
                    description: successful operation
                    content:
                        application/json:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Institution-Shifts"
                        application/xml:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Institution-Shifts"
                "400":
                    description: Invalid status value

    /api/v4/institutions/{institutionId}/shifts/{shiftId}:
        get:
            tags:
                - Institution Shifts
            summary: Get One Shift for one Institution
            description: Multiple values can be provided with comma separated strings
            parameters:
                - name: academic_period_id
                  in: query
                  description: This is to filter the results based on the academic_period_id
                  required: false
                  schema:
                      type: integer
                - name: limit
                  in: header
                  description: This is to limit the number of result
                  required: false
                  schema:
                      type: integer
                - name: order
                  in: header
                  description: This is to sort the results
                  required: false
                  schema:
                      type: string
                - name: page
                  in: header
                  description: This is to display the results based on the page number
                  required: false
                  schema:
                      type: integer
                - name: institutionId
                  in: path
                  description: Add Institution id to filter
                  required: true
                  schema:
                      type: integer
                      format: int
                - name: shiftId
                  in: path
                  description: Add Institution id to filter
                  required: true
                  schema:
                      type: integer
                      format: int
            responses:
                "200":
                    description: successful operation
                    content:
                        application/json:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Institution-Shifts"
                        application/xml:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Institution-Shifts"
                "400":
                    description: Invalid status value

    /api/v4/institutions/areas:
        get:
            tags:
                - Institution Areas
            summary: Get All Areas for All Institution
            description: Multiple values can be provided with comma separated strings
            responses:
                "200":
                    description: successful operation
                    content:
                        application/json:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Institution-Areas"
                        application/xml:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Institution-Areas"
                "400":
                    description: Invalid status value

    /api/v4/institutions/{institutionId}/areas:
        get:
            tags:
                - Institution Areas
            summary: Get All Areas for one Institution
            description: Multiple values can be provided with comma separated strings
            parameters:
                - name: institutionId
                  in: path
                  description: Add Institution id to filter
                  required: true
                  schema:
                      type: integer
                      format: int
            responses:
                "200":
                    description: successful operation
                    content:
                        application/json:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Institution-Areas"
                        application/xml:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Institution-Areas"
                "400":
                    description: Invalid status value

    /api/v4/institutions/{institutionId}/areas/{areaId}:
        get:
            tags:
                - Institution Areas
            summary: Get one Area for one Institution
            description: Multiple values can be provided with comma separated strings
            parameters:
                - name: institutionId
                  in: path
                  description: Add Institution id to filter
                  required: true
                  schema:
                      type: integer
                      format: int
                - name: areaId
                  in: path
                  description: Add Institution id to filter
                  required: true
                  schema:
                      type: integer
                      format: int
            responses:
                "200":
                    description: successful operation
                    content:
                        application/json:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Institution-Areas"
                        application/xml:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Institution-Areas"
                "400":
                    description: Invalid status value

    /api/v4/institutions/summaries:
        get:
            tags:
                - Institution Summary
            summary: Get All Grades for one Institution
            description: Multiple grades can be provided with comma separated strings
            parameters:
                - name: academic_period_id
                  in: query
                  description: This is to filter the results based on the academic_period_id
                  required: false
                  schema:
                      type: integer
                - name: limit
                  in: header
                  description: This is to limit the number of result
                  required: false
                  schema:
                      type: integer
                - name: order
                  in: header
                  description: This is to sort the results
                  required: false
                  schema:
                      type: string
                - name: page
                  in: header
                  description: This is to display the results based on the page number
                  required: false
                  schema:
                      type: integer
            responses:
                "200":
                    description: successful operation
                    content:
                        application/json:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Institution-Summary"
                        application/xml:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Institution-Summary"
                "400":
                    description: Invalid status value

    /api/v4/institutions/{institutionId}/summaries:
        get:
            tags:
                - Institution Summary
            summary: Get All Grades for one Institution
            description: Multiple grades can be provided with comma separated strings
            parameters:
                - name: academic_period_id
                  in: query
                  description: This is to filter the results based on the academic_period_id
                  required: false
                  schema:
                      type: integer
                - name: limit
                  in: header
                  description: This is to limit the number of result
                  required: false
                  schema:
                      type: integer
                - name: order
                  in: header
                  description: This is to sort the results
                  required: false
                  schema:
                      type: string
                - name: page
                  in: header
                  description: This is to display the results based on the page number
                  required: false
                  schema:
                      type: integer
                - name: institutionId
                  in: path
                  description: Add Institution id to filter
                  required: true
                  schema:
                      type: integer
                      format: int
            responses:
                "200":
                    description: successful operation
                    content:
                        application/json:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Institution-Summary"
                        application/xml:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Institution-Summary"
                "400":
                    description: Invalid status value

    /api/v4/institutions/grades/summaries:
        get:
            tags:
                - Institution Grade Summary
            summary: Get Grades Summaries for All Institution
            description: Multiple values can be provided with comma separated strings
            responses:
                "200":
                    description: successful operation
                    content:
                        application/json:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Institution-Grade-Summary"
                        application/xml:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Institution-Grade-Summary"
                "400":
                    description: Invalid status value

    /api/v4/institutions/{institutionId}/grades/summaries:
        get:
            tags:
                - Institution Grade Summary
            summary: Get Grades Summary for one Institution
            description: Multiple values can be provided with comma separated strings
            parameters:
                - name: academic_period_id
                  in: query
                  description: This is to filter the results based on the academic_period_id
                  required: false
                  schema:
                      type: integer
                - name: limit
                  in: header
                  description: This is to limit the number of result
                  required: false
                  schema:
                      type: integer
                - name: order
                  in: header
                  description: This is to sort the results
                  required: false
                  schema:
                      type: string
                - name: page
                  in: header
                  description: This is to display the results based on the page number
                  required: false
                  schema:
                      type: integer
                - name: institutionId
                  in: path
                  description: Add Institution id to filter
                  required: true
                  schema:
                      type: integer
                      format: int
            responses:
                "200":
                    description: successful operation
                    content:
                        application/json:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Institution-Grade-Summary"
                        application/xml:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Institution-Grade-Summary"
                "400":
                    description: Invalid status value

    /api/v4/institutions/{institutionId}/grades/{gradeId}/summaries:
        get:
            tags:
                - Institution Grade Summary
            summary: Get Grade summary for one Institution
            description: Multiple values can be provided with comma separated strings
            parameters:
                - name: academic_period_id
                  in: query
                  description: This is to filter the results based on the academic_period_id
                  required: false
                  schema:
                      type: integer
                - name: limit
                  in: header
                  description: This is to limit the number of result
                  required: false
                  schema:
                      type: integer
                - name: order
                  in: header
                  description: This is to sort the results
                  required: false
                  schema:
                      type: string
                - name: page
                  in: header
                  description: This is to display the results based on the page number
                  required: false
                  schema:
                      type: integer
                - name: institutionId
                  in: path
                  description: Add Institution id to filter
                  required: true
                  schema:
                      type: integer
                      format: int
                - name: gradeId
                  in: path
                  description: Add Institution id to filter
                  required: true
                  schema:
                      type: integer
                      format: int
            responses:
                "200":
                    description: successful operation
                    content:
                        application/json:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Institution-Grade-Summary"
                        application/xml:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Institution-Grade-Summary"
                "400":
                    description: Invalid status value

    /api/v4/institutions/room-type-summaries:
        get:
            tags:
                - Institution Room Type Summary
            summary: Get Infrastructure summary for all Institution
            description: Multiple grades can be provided with comma separated strings
            parameters:
                - name: academic_period_id
                  in: query
                  description: This is to filter the results based on the academic_period_id
                  required: false
                  schema:
                      type: integer
                - name: limit
                  in: header
                  description: This is to limit the number of result
                  required: false
                  schema:
                      type: integer
                - name: order
                  in: header
                  description: This is to sort the results
                  required: false
                  schema:
                      type: string
                - name: page
                  in: header
                  description: This is to display the results based on the page number
                  required: false
                  schema:
                      type: integer
            responses:
                "200":
                    description: successful operation
                    content:
                        application/json:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Room-Type-Summaries"
                        application/xml:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Room-Type-Summaries"
                "400":
                    description: Invalid status value

    /api/v4/institutions/{institutionId}/infrastructure-summaries:
        get:
            tags:
                - Institution Room Type Summary
            summary: Get Infrastructure summary for one Institution
            description: Multiple grades can be provided with comma separated strings
            parameters:
                - name: academic_period_id
                  in: query
                  description: This is to filter the results based on the academic_period_id
                  required: false
                  schema:
                      type: integer
                - name: limit
                  in: header
                  description: This is to limit the number of result
                  required: false
                  schema:
                      type: integer
                - name: order
                  in: header
                  description: This is to sort the results
                  required: false
                  schema:
                      type: string
                - name: page
                  in: header
                  description: This is to display the results based on the page number
                  required: false
                  schema:
                      type: integer
                - name: institutionId
                  in: path
                  description: Add Institution id to filter
                  required: true
                  schema:
                      type: integer
                      format: int
            responses:
                "200":
                    description: successful operation
                    content:
                        application/json:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Room-Type-Summaries"
                        application/xml:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Room-Type-Summaries"
                "400":
                    description: Invalid status value

    /api/v4/institutions/student-nationality-summaries:
        get:
            tags:
                - Institution Student Nationality Summary
            summary: Get All student nationality summaries for all Institution
            description: Multiple values can be provided with comma separated strings
            parameters:
                - name: academic_period_id
                  in: query
                  description: This is to filter the results based on the academic_period_id
                  required: false
                  schema:
                      type: integer
                - name: limit
                  in: header
                  description: This is to limit the number of result
                  required: false
                  schema:
                      type: integer
                - name: order
                  in: header
                  description: This is to sort the results
                  required: false
                  schema:
                      type: string
                - name: page
                  in: header
                  description: This is to display the results based on the page number
                  required: false
                  schema:
                      type: integer
            responses:
                "200":
                    description: successful operation
                    content:
                        application/json:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Institution-Grades"
                        application/xml:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Institution-Grades"
                "400":
                    description: Invalid status value

    /api/v4/institutions/{institutionId}/student-nationality-summaries:
        get:
            tags:
                - Institution Student Nationality Summary
            summary: Get All student nationality summaries for one Institution
            description: Multiple values can be provided with comma separated strings
            parameters:
                - name: academic_period_id
                  in: query
                  description: This is to filter the results based on the academic_period_id
                  required: false
                  schema:
                      type: integer
                - name: limit
                  in: header
                  description: This is to limit the number of result
                  required: false
                  schema:
                      type: integer
                - name: order
                  in: header
                  description: This is to sort the results
                  required: false
                  schema:
                      type: string
                - name: page
                  in: header
                  description: This is to display the results based on the page number
                  required: false
                  schema:
                      type: integer
                - name: institutionId
                  in: path
                  description: Add Institution id to filter
                  required: true
                  schema:
                      type: integer
                      format: int
            responses:
                "200":
                    description: successful operation
                    content:
                        application/json:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Institution-Student-Nationality-Summary"
                        application/xml:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Institution-Student-Nationality-Summary"
                "400":
                    description: Invalid status value

    /api/v4/institutions/{institutionId}/grades/{gradeId}/student-nationality-summaries:
        get:
            tags:
                - Institution Student Nationality Summary
            summary: Get student nationality summary from one Grade for one Institution
            description: Multiple values can be provided with comma separated strings
            parameters:
                - name: academic_period_id
                  in: query
                  description: This is to filter the results based on the academic_period_id
                  required: false
                  schema:
                      type: integer
                - name: limit
                  in: header
                  description: This is to limit the number of result
                  required: false
                  schema:
                      type: integer
                - name: order
                  in: header
                  description: This is to sort the results
                  required: false
                  schema:
                      type: string
                - name: page
                  in: header
                  description: This is to display the results based on the page number
                  required: false
                  schema:
                      type: integer
                - name: institutionId
                  in: path
                  description: Add Institution id to filter
                  required: true
                  schema:
                      type: integer
                      format: int
                - name: gradeId
                  in: path
                  description: Add Grade id to filter
                  required: true
                  schema:
                      type: integer
                      format: int
            responses:
                "200":
                    description: successful operation
                    content:
                        application/json:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Institution-Grades"
                        application/xml:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Institution-Grades"
                "400":
                    description: Invalid status value

    /api/v4/users/{userId}:
        get:
            tags:
                - User Details
            summary: Get User details for one user
            description: Multiple values can be provided with comma separated strings
            parameters:
                - name: userId
                  in: path
                  description: Add Institution id to filter
                  required: true
                  schema:
                      type: integer
                      format: int
            responses:
                "200":
                    description: successful operation
                    content:
                        application/json:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/User-Details"
                        application/xml:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/User-Details"
                "400":
                    description: Invalid status value

    /api/v4/users/openemis_id/{openemis_id}:
        get:
            tags:
                - User Details
            summary: Get All User details
            description: Multiple values can be provided with comma separated strings
            parameters:
                - name: openemis_id
                  in: path
                  description: Add openemis_id to filter
                  required: true
                  schema:
                      type: string
                      format: varchar
            responses:
                "200":
                    description: successful operation
                    content:
                        application/json:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/User-Name-List"
                "400":
                    description: Invalid status value

    /api/v4/identity-types/list:
        get:
            tags:
                - Identity Types
            summary: Get All identity types
            description: Multiple values can be provided with comma separated strings
            responses:
                "200":
                    description: successful operation
                    content:
                        application/json:
                            schema:
                                $ref: "#/components/schemas/Identities-Type"
                "404":
                    description: Nationalities list found.

    /api/v4/nationalities/list:
        get:
            tags:
                - User Details
            summary: Get All Nationalities
            description: Multiple values can be provided with comma separated strings
            responses:
                "200":
                    description: successful operation
                "400":
                    description: Invalid status value

    /api/v4/student-custom-fields:
        get:
            tags:
                - User Details
            summary: Get All Student Custom Fields
            description: Multiple values can be provided with comma separated strings
            responses:
                "200":
                    description: successful operation
                "400":
                    description: Invalid status value

    /api/v4/users/identity-types/{identity_type_id}/{identity_number}:
        get:
            tags:
                - User Details
            summary: Get All User details
            description: Multiple values can be provided with comma separated strings
            parameters:
                - name: identity_type_id
                  in: path
                  description: Add openemis_id to filter
                  required: true
                  schema:
                      type: string
                      format: varchar
                - name: identity_number
                  in: path
                  description: Add openemis_id to filter
                  required: true
                  schema:
                      type: string
                      format: varchar
            responses:
                "200":
                    description: successful operation
                    content:
                        application/json:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/User-Details"
                        application/xml:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/User-Details"
                "400":
                    description: Invalid status value

    /api/v4/institutions/{institutionId}/student-admission:
        post:
            tags:
                - User Details
            summary: Student Admission to an Institution
            description: Multiple values can be provided with comma separated strings
            parameters:
                - name: institutionId
                  in: path
                  description: Add Institution id to filter
                  required: true
                  schema:
                      type: integer
                      format: int
            responses:
                "200":
                    description: successful operation
                "400":
                    description: Invalid status value

    /api/v4/institutions/{institutionId}/staff:
        get:
            tags:
                - Institution Staff
            summary: Get All staff for one Institution
            description: Multiple values can be provided with comma separated strings
            parameters:
                - name: institutionId
                  in: path
                  description: Add Institution id to filter
                  required: true
                  schema:
                      type: integer
                      format: int
            responses:
                "200":
                    description: successful operation
                    content:
                        application/json:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Institution-Staff"
                        application/xml:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Institution-Staff"
                "400":
                    description: Invalid status value

    /api/v4/institutions/{institutionId}/staff/{staffId}:
        get:
            tags:
                - Institution Staff
            summary: Get one staff for one Institution
            description: Multiple values can be provided with comma separated strings
            parameters:
                - name: institutionId
                  in: path
                  description: Add Institution id to filter
                  required: true
                  schema:
                      type: integer
                      format: int
                - name: staffId
                  in: path
                  description: Add Institution id to filter
                  required: true
                  schema:
                      type: integer
                      format: int
            responses:
                "200":
                    description: successful operation
                    content:
                        application/json:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Institution-Staff"
                        application/xml:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Institution-Staff"
                "400":
                    description: Invalid status value

    /api/v4/institutions/positions:
        get:
            tags:
                - Institution Positions
            summary: Get All positions for All Institution
            description: Multiple values can be provided with comma separated strings
            responses:
                "200":
                    description: successful operation
                    content:
                        application/json:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Institution-Positions"
                        application/xml:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Institution-Positions"
                "400":
                    description: Invalid status value

    /api/v4/institutions/{institutionId}/positions:
        get:
            tags:
                - Institution Positions
            summary: Get All Positions for one Institution
            description: Multiple values can be provided with comma separated strings
            parameters:
                - name: institutionId
                  in: path
                  description: Add Institution id to filter
                  required: true
                  schema:
                      type: integer
                      format: int
            responses:
                "200":
                    description: successful operation
                    content:
                        application/json:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Institution-Positions"
                        application/xml:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Institution-Positions"
                "400":
                    description: Invalid status value

    /api/v4/institutions/{institutionId}/positions/{positionId}:
        get:
            tags:
                - Institution Positions
            summary: Get one position for one Institution
            description: Multiple grades can be provided with comma separated strings
            parameters:
                - name: institutionId
                  in: path
                  description: Add Institution id to filter
                  required: true
                  schema:
                      type: integer
                      format: int
                - name: positionId
                  in: path
                  description: Add Institution id to filter
                  required: true
                  schema:
                      type: integer
                      format: int
            responses:
                "200":
                    description: successful operation
                    content:
                        application/json:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Institution-Positions"
                        application/xml:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Institution-Positions"
                "400":
                    description: Invalid status value

    /api/v4/locale-contents:
        get:
            tags:
                - Locale Content Details
            summary: Get All translations
            description: Multiple grades can be provided with comma separated strings
            responses:
                "200":
                    description: successful operation
                    content:
                        application/json:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Locale-Content-Details"
                        application/xml:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Locale-Content-Details"
                "400":
                    description: Invalid status value

    /api/v4/locale-contents/{localeId}:
        get:
            tags:
                - Locale Content Details
            summary: Get All Translations for one Language
            description: Multiple values can be provided with comma separated strings
            parameters:
                - name: localeId
                  in: path
                  description: Add Institution id to filter
                  required: true
                  schema:
                      type: integer
                      format: int
            responses:
                "200":
                    description: successful operation
                    content:
                        application/json:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Locale-Content-Details"
                        application/xml:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Locale-Content-Details"
                "400":
                    description: Invalid status value

    /api/v4/institutions/{institutionId}/students/{studentId}/assessment-item-results:
        get:
            tags:
                - Institutions
            summary: Get All Assessment Item Results
            description: Get All Assessment Item Results
            parameters:
                - name: institutionId
                  in: path
                  description: Add Institution id to filter
                  required: true
                  schema:
                      type: integer
                      format: int
                - name: studentId
                  in: path
                  description: Add Student id to filter
                  required: true
                  schema:
                      type: integer
                      format: int
            responses:
                "200":
                    description: successful operation
                    content:
                        application/json:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Assessment-Item-Results"
                        application/xml:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Assessment-Item-Results"
                "400":
                    description: Invalid status value

    /api/v4/institutions/subjects/staff:
        get:
            tags:
                - Institution
            summary: Get Staff's Subjects detail
            description: Get staff's subjects details on the bases of institution
            parameters:
                - name: staff_id
                  in: query
                  description: Add Staff id to filter
                  required: true
                  schema:
                      type: integer
                      format: int
                - name: institution_id
                  in: query
                  description: Add Institution id to filter
                  required: true
                  schema:
                      type: integer
                      format: int
            responses:
                "200":
                    description: successful operation
                    content:
                        application/json:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Institution-Subjects-Staff"
                        application/xml:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Institution-Subjects-Staff"
                "400":
                    description: Invalid status value

    # POCOR-7391 Update OpenEMIS Core Swagger API v4 documentation (starts)

    /api/v4/areas/list:
        get:
            tags:
                - Areas List
            summary: Get List for Areas
            description: Multiple area list will be provided with comma separated strings
            responses:
                "200":
                    description: successful operation
                "400":
                    description: Invalid status value

    /api/v4/area-levels/list:
        get:
            tags:
                - Areas List
            summary: Get list for levels for all areas
            description: Multiple area list will be provided with comma separated strings
            responses:
                "200":
                    description: successful operation
                "400":
                    description: Invalid status value

    /api/v4/institution-types/list:
        get:
            tags:
                - Institutions
            summary: Get Types of Institutions
            description: Multiple Institution Types will be provided with comma separated strings
            responses:
                "200":
                    description: successful operation
                    content:
                        application/json:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Institution-Types-List"
                "400":
                    description: Invalid status value

    /api/v4/institutions/grades/student-nationality-summaries:
        get:
            tags:
                - Institution Student Nationality Summary
            summary: Get student nationality summaries  grades for all institution
            description: Multiple values can be provided with comma separated strings
            parameters:
                - name: academic_period_id
                  in: query
                  description: This is to filter the results based on the academic_period_id
                  required: false
                  schema:
                      type: integer
                - name: limit
                  in: header
                  description: This is to limit the number of result
                  required: false
                  schema:
                      type: integer
                - name: order
                  in: header
                  description: This is to sort the results
                  required: false
                  schema:
                      type: string
                - name: page
                  in: header
                  description: This is to display the results based on the page number
                  required: false
                  schema:
                      type: integer
            responses:
                "200":
                    description: successful operation
                    content:
                        application/json:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Institution-Grades"
                        application/xml:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Institution-Grades"
                "400":
                    description: Invalid status value

    /api/v4/institutions/grades/{gradeId}/list:
        get:
            tags:
                - Institution Grades
            summary: Get list Grades for all Institution
            description: Multiple grades can be provided with comma separated strings
            parameters:
                - name: academic_period_id
                  in: query
                  description: This is to filter the results based on the academic_period_id
                  required: false
                  schema:
                      type: integer
                - name: limit
                  in: header
                  description: This is to limit the number of result
                  required: false
                  schema:
                      type: integer
                - name: order
                  in: header
                  description: This is to sort the results
                  required: false
                  schema:
                      type: string
                - name: page
                  in: header
                  description: This is to display the results based on the page number
                  required: false
                  schema:
                      type: integer
                - name: gradeId
                  in: path
                  description: Add grade id to filter
                  required: true
                  schema:
                      type: integer
                      format: int
            responses:
                "200":
                    description: successful operation
                    content:
                        application/json:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Institution-Grades"
                        application/xml:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Institution-Grades"
                "400":
                    description: Invalid status value

    /api/v4/institutions/{institutionId}/grades/{gradeId}/students/{studentId}:
        get:
            tags:
                - Institution Grades
            summary: Get student Grades for one Institution
            description: Multiple values can be provided with comma separated strings
            parameters:
                - name: academic_period_id
                  in: query
                  description: This is to filter the results based on the academic_period_id
                  required: false
                  schema:
                      type: integer
                - name: limit
                  in: header
                  description: This is to limit the number of result
                  required: false
                  schema:
                      type: integer
                - name: order
                  in: header
                  description: This is to sort the results
                  required: false
                  schema:
                      type: string
                - name: page
                  in: header
                  description: This is to display the results based on the page number
                  required: false
                  schema:
                      type: integer
                - name: institutionId
                  in: path
                  description: Add Institution id to filter
                  required: true
                  schema:
                      type: integer
                      format: int
                - name: gradeId
                  in: path
                  description: Add grade id to filter
                  required: true
                  schema:
                      type: integer
                      format: int
                - name: studentId
                  in: path
                  description: Add student id to filter
                  required: true
                  schema:
                      type: integer
                      format: int
            responses:
                "200":
                    description: successful operation
                    content:
                        application/json:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Institution-Grades"
                        application/xml:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Institution-Grades"
                "400":
                    description: Invalid status value

    /api/v4/systems/{system_id}/levels/{level_id}/cycles/{cycle_id}/programmes/grades/subjects:
        get:
            tags:
                - Education Structure Details
            summary: Get All Grade Subjects
            description: Multiple values can be provided with comma separated strings
            parameters:
                - name: academic_period_id
                  in: query
                  description: This is to filter the results based on the academic_period_id
                  required: false
                  schema:
                      type: integer
                - name: limit
                  in: header
                  description: This is to limit the number of result
                  required: false
                  schema:
                      type: integer
                - name: order
                  in: header
                  description: This is to sort the results
                  required: false
                  schema:
                      type: string
                - name: page
                  in: header
                  description: This is to display the results based on the page number
                  required: false
                  schema:
                      type: integer
                - name: system_id
                  in: path
                  description: The level id
                  required: true
                  schema:
                      type: integer
                - name: level_id
                  in: path
                  description: education_level_id
                  required: true
                  schema:
                      type: integer
                - name: cycle_id
                  in: path
                  description: education_cycle_id
                  required: true
                  schema:
                      type: integer
            responses:
                "200":
                    description: successful operation
                    content:
                        application/json:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Education-System"
                        application/xml:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Education-System"
                "400":
                    description: Invalid status value

    /api/v4/systems/{system_id}/levels/{level_id}/cycles/{cycle_id}/programmes/{programme_id}/grades/{grade_id}/competencies:
        get:
            tags:
                - Education Structure Details
            summary: Get Grades for competencies
            description: Multiple values can be provided with comma separated strings
            parameters:
                - name: academic_period_id
                  in: query
                  description: This is to filter the results based on the academic_period_id
                  required: false
                  schema:
                      type: integer
                - name: limit
                  in: header
                  description: This is to limit the number of result
                  required: false
                  schema:
                      type: integer
                - name: order
                  in: header
                  description: This is to sort the results
                  required: false
                  schema:
                      type: string
                - name: page
                  in: header
                  description: This is to display the results based on the page number
                  required: false
                  schema:
                      type: integer
                - name: system_id
                  in: path
                  description: The level id
                  required: true
                  schema:
                      type: integer
                - name: level_id
                  in: path
                  description: education_level_id
                  required: true
                  schema:
                      type: integer
                - name: cycle_id
                  in: path
                  description: education_cycle_id
                  required: true
                  schema:
                      type: integer
                - name: programme_id
                  in: path
                  description: education_programme_id
                  required: true
                  schema:
                      type: integer
                - name: grade_id
                  in: path
                  description: education_grade_id
                  required: true
                  schema:
                      type: integer
            responses:
                "200":
                    description: successful operation
                    content:
                        application/json:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Education-System"
                        application/xml:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Education-System"
                "400":
                    description: Invalid status value

    /api/v4/systems/{system_id}/levels/{level_id}/cycles/{cycle_id}/programmes/{programme_id}/grades/{grade_id}/reportcards:
        get:
            tags:
                - Education Structure Details
            summary: Get Grades for reportcards
            description: Multiple values can be provided with comma separated strings
            parameters:
                - name: academic_period_id
                  in: query
                  description: This is to filter the results based on the academic_period_id
                  required: false
                  schema:
                      type: integer
                - name: limit
                  in: header
                  description: This is to limit the number of result
                  required: false
                  schema:
                      type: integer
                - name: order
                  in: header
                  description: This is to sort the results
                  required: false
                  schema:
                      type: string
                - name: page
                  in: header
                  description: This is to display the results based on the page number
                  required: false
                  schema:
                      type: integer
                - name: system_id
                  in: path
                  description: The level id
                  required: true
                  schema:
                      type: integer
                - name: level_id
                  in: path
                  description: education_level_id
                  required: true
                  schema:
                      type: integer
                - name: cycle_id
                  in: path
                  description: education_cycle_id
                  required: true
                  schema:
                      type: integer
                - name: programme_id
                  in: path
                  description: education_programme_id
                  required: true
                  schema:
                      type: integer
                - name: grade_id
                  in: path
                  description: education_grade_id
                  required: true
                  schema:
                      type: integer
            responses:
                "200":
                    description: successful operation
                    content:
                        application/json:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Education-System"
                        application/xml:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Education-System"
                "400":
                    description: Invalid status value

    /api/v4/details-by-emis/{openemis_id}: #details-by-emis/{id}
        get:
            tags:
                - User Details
            summary: Get details of user by emis id
            description: Multiple values can be provided with comma separated strings
            parameters:
                - name: openemis_id
                  in: path
                  description: Add openemis_id to filter
                  required: true
                  schema:
                      type: string
                      format: varchar
            responses:
                "200":
                    description: successful operation
                    content:
                        application/json:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/User-Details"
                        application/xml:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/User-Details"
                "400":
                    description: Invalid status value

    /api/v4/institutions/{institutionId}/classes/{classId}/reportcardcomment:
        post:
            tags:
                - Institution Classes
            summary: Reportcard comment to a class
            description: Multiple values can be provided with comma separated strings
            parameters:
                - name: institutionId
                  in: path
                  description: Add Institution id to filter
                  required: true
                  schema:
                      type: integer
                      format: int
                - name: classId
                  in: path
                  description: Add class id to filter
                  required: true
                  schema:
                      type: integer
                      format: int
            responses:
                "200":
                    description: successful operation
                "400":
                    description: Invalid value

    /api/v4/institutions/{institutionId}/classes/{classId}/reportcardcomment/homeroom:
        post:
            tags:
                - Institution Classes
            summary: Homeroom reportcard comment to a class
            description: Multiple values can be provided with comma separated strings
            parameters:
                - name: institutionId
                  in: path
                  description: Add Institution id to filter
                  required: true
                  schema:
                      type: integer
                      format: int
                - name: classId
                  in: path
                  description: Add class id to filter
                  required: true
                  schema:
                      type: integer
                      format: int
            responses:
                "200":
                    description: successful operation
                "400":
                    description: Invalid value

    /api/v4/institutions/{institutionId}/classes/{classId}/reportcardcomment/principal:
        post:
            tags:
                - Institution Classes
            summary: Principal reportcard comment to a class
            description: Multiple values can be provided with comma separated strings
            parameters:
                - name: institutionId
                  in: path
                  description: Add Institution id to filter
                  required: true
                  schema:
                      type: integer
                      format: int
                - name: classId
                  in: path
                  description: Add class id to filter
                  required: true
                  schema:
                      type: integer
                      format: int
            responses:
                "200":
                    description: successful operation
                "400":
                    description: Invalid value

    /api/v4/institutions/students/competencies/comments:
        post:
            tags:
                - Institution students
            summary: Competencies comments
            description: Multiple values can be provided with comma separated strings
            parameters:
                - name: academic_period_id
                  in: query
                  description: This is to filter the results based on the academic_period_id
                  required: false
                  schema:
                      type: integer
                - name: limit
                  in: header
                  description: This is to limit the number of result
                  required: false
                  schema:
                      type: integer
                - name: order
                  in: header
                  description: This is to sort the results
                  required: false
                  schema:
                      type: string
                - name: page
                  in: header
                  description: This is to display the results based on the page number
                  required: false
                  schema:
                      type: integer
            responses:
                "200":
                    description: successful operation
                "400":
                    description: Invalid status value

    /api/v4/institutions/students/competencies/results:
        post:
            tags:
                - Institution students
            summary: Competencies results
            description: Multiple values can be provided with comma separated strings
            parameters:
                - name: academic_period_id
                  in: query
                  description: This is to filter the results based on the academic_period_id
                  required: false
                  schema:
                      type: integer
                - name: limit
                  in: header
                  description: This is to limit the number of result
                  required: false
                  schema:
                      type: integer
                - name: order
                  in: header
                  description: This is to sort the results
                  required: false
                  schema:
                      type: string
                - name: page
                  in: header
                  description: This is to display the results based on the page number
                  required: false
                  schema:
                      type: integer
            responses:
                "200":
                    description: successful operation
                "400":
                    description: Invalid status value

    /api/v4/institutions/students/competencies/periods/comments:
        post:
            tags:
                - Institution students
            summary: Competencies periods comments
            description: Multiple values can be provided with comma separated strings
            parameters:
                - name: academic_period_id
                  in: query
                  description: This is to filter the results based on the academic_period_id
                  required: false
                  schema:
                      type: integer
                - name: limit
                  in: header
                  description: This is to limit the number of result
                  required: false
                  schema:
                      type: integer
                - name: order
                  in: header
                  description: This is to sort the results
                  required: false
                  schema:
                      type: string
                - name: page
                  in: header
                  description: This is to display the results based on the page number
                  required: false
                  schema:
                      type: integer
            responses:
                "200":
                    description: successful operation
                "400":
                    description: Invalid status value

    # POCOR-7391 ends
    # POCOR-7368 starts

    /api/v4/institutions/{institutionId}/textbooks/{textbookId}:
        get:
            tags:
                - Textbook Details
            summary: Get one textbook for one Institution
            description: Multiple grades can be provided with comma separated strings
            parameters:
                - name: institutionId
                  in: path
                  description: Add Institution id to filter
                  required: true
                  schema:
                      type: integer
                      format: int
                - name: textbookId
                  in: path
                  description: Add textbook id to filter
                  required: true
                  schema:
                      type: integer
                      format: int
            responses:
                "200":
                    description: successful operation
                    content:
                        application/json:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/InstitutionTextbooks"
                        application/xml:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/InstitutionTextbooks"
                "400":
                    description: Invalid status value

    /api/v4/textbooks/{textbookId}:
        get:
            tags:
                - Textbook Details
            summary: Get One Textbook from Textbooks
            description: Multiple values can be provided with comma separated strings
            parameters:
                - name: textbookId
                  in: path
                  description: Add Textbook id to filter
                  required: true
                  schema:
                      type: integer
                      format: int
            responses:
                "200":
                    description: successful operation
                    content:
                        application/json:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Textbooks"
                        application/xml:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Textbooks"
                "400":
                    description: Invalid status value

    /api/v4/textbooks-statuses:
        get:
            tags:
                - Textbook Details
            summary: Get All Textbook Status
            description: Multiple values can be provided with comma separated strings
            responses:
                "200":
                    description: successful operation
                    content:
                        application/json:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/TextbookStatuses"
                        application/xml:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/TextbookStatuses"
                "400":
                    description: Invalid status value

    /api/v4/textbooks-dimensions:
        get:
            tags:
                - Textbook Details
            summary: Get All Textbook Dimension
            description: Multiple values can be provided with comma separated strings
            responses:
                "200":
                    description: successful operation
                    content:
                        application/json:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/TextbookDimensions"
                        application/xml:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/TextbookDimensions"
                "400":
                    description: Invalid status value

    /api/v4/textbooks-conditions:
        get:
            tags:
                - Textbook Details
            summary: Get All Textbook Condition
            description: Multiple values can be provided with comma separated strings
            responses:
                "200":
                    description: successful operation
                    content:
                        application/json:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/TextbookConditions"
                        application/xml:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/TextbookConditions"
                "400":
                    description: Invalid status value

    /api/v4/textbooks:
        post:
            tags:
                - Textbook Details
            summary: Add Textbooks
            description: Multiple values can be provided with comma separated strings
            parameters:
                - name: academic_period_id
                  in: query
                  description: This is to filter the results based on the academic_period_id
                  required: true
                  schema:
                      type: integer
                - name: title
                  in: query
                  description: This is the title of the textbook.
                  required: true
                  schema:
                      type: string
                - name: year_published
                  in: query
                  description: This is year in which the textbook is published.
                  required: true
                  schema:
                      type: integer
                - name: education_grade_id
                  in: query
                  description: This is to filter the results based on the education_grade_id
                  required: true
                  schema:
                      type: integer
                - name: education_subject_id
                  in: query
                  description: This is to filter the results based on the education_subject_id
                  required: true
                  schema:
                      type: integer
                - name: code
                  in: query
                  description: This is the code of textbook.
                  required: false
                  schema:
                      type: string
                - name: publisher
                  in: query
                  description: This is the publisher of textbook.
                  required: false
                  schema:
                      type: string
                - name: ISBN
                  in: query
                  description: This is the ISBN of textbook.
                  required: false
                  schema:
                      type: string
                - name: author
                  in: query
                  description: This is the author of textbook.
                  required: false
                  schema:
                      type: string
                - name: expiry_date
                  in: query
                  description: This is the expiry date of textbook.
                  required: false
                  schema:
                      type: string
                - name: textbook_dimension_id
                  in: query
                  description: This is the textbook dimension id of textbook.
                  required: false
                  schema:
                      type: integer
            responses:
                "200":
                    description: successful operation
                "400":
                    description: Invalid value

    /api/v4/institutions/{institutionId}/textbooks:
        post:
            tags:
                - Textbook Details
            summary: Add Textbook For A Institution
            description: Multiple values can be provided with comma separated strings
            parameters:
                - name: institutionId
                  in: path
                  description: Add Institution id to filter
                  required: true
                  schema:
                      type: integer
                      format: int
                - name: Academic Period Id
                  in: header
                  description: Add academic period id in request parameters.
                  required: true
                  schema:
                      type: integer
                      format: int
                - name: Education Grade Id
                  in: header
                  description: Add education grade id in request parameters.
                  required: true
                  schema:
                      type: integer
                      format: int
                - name: Education Subject Id
                  in: header
                  description: Add education subject id in request parameters.
                  required: true
                  schema:
                      type: integer
                      format: int
                - name: Textbook Id
                  in: header
                  description: Add textbook id in request parameters.
                  required: true
                  schema:
                      type: integer
                      format: int
                - name: code
                  in: query
                  description: This is the code of textbook.
                  required: false
                  schema:
                      type: string
                - name: comment
                  in: query
                  description: This is the comment of textbook.
                  required: false
                  schema:
                      type: string
                - name: textbook_status_id
                  in: query
                  description: This is the textbook status id of textbook.
                  required: false
                  schema:
                      type: integer
                - name: textbook_condition_id
                  in: query
                  description: This is the textbook condition id of textbook.
                  required: false
                  schema:
                      type: integer
                - name: security_user_id
                  in: query
                  description: This is the security user id.
                  required: false
                  schema:
                      type: integer
            responses:
                "200":
                    description: successful operation
                "400":
                    description: Invalid value

    # POCOR-7368 ends

    # POCOR-7394-S starts

    /api/v4/users/genders:
        get:
            tags:
                - User Details
            summary: Get User Gender
            description: Multiple user will be provided with comma separated strings
            responses:
                "200":
                    description: successful operation
                    content:
                        application/json:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/User-Genders"
                        application/xml:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/User-Genders"
                "400":
                    description: Invalid status value

    /api/v4/institutions/genders:
        get:
            tags:
                - Institutions
            summary: Get Institution Gender
            description: Multiple Institution will be provided with comma separated strings
            responses:
                "200":
                    description: successful operation
                    content:
                        application/json:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Institutions-Genders"
                        application/xml:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Institutions-Genders"
                "400":
                    description: Invalid status value

    /api/v4/absence-reasons:
        get:
            tags:
                - Student Attendance
            summary: Get Institution Student Absence Reasons
            description: Multiple Absence Reasons will be provided with comma separated strings
            responses:
                "200":
                    description: successful operation
                    content:
                        application/json:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Absence-Reasons"
                "400":
                    description: Invalid status value

    /api/v4/absence-types:
        get:
            tags:
                - Student Attendance
            summary: Get Institution Absence Types
            description: Multiple Absence Types will be provided with comma separated strings
            responses:
                "200":
                    description: successful operation
                    content:
                        application/json:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Absence-Types"
                "400":
                    description: Invalid status value

    /api/v4/area-administratives:
        get:
            tags:
                - Institution Areas
            summary: Get Area Administratives
            description: Multiple Area Administratives will be provided with comma separated strings
            parameters:
                - name: limit
                  in: header
                  description: This is to limit the number of result
                  required: false
                  schema:
                      type: integer
                - name: page
                  in: header
                  description: This is to display the results based on the page number
                  required: false
                  schema:
                      type: integer
            responses:
                "200":
                    description: successful operation
                    content:
                        application/json:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Area-Administratives"
                        application/xml:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Area-Administratives"
                "400":
                    description: Invalid status value

    /api/v4/area-administratives/{areaadministrativeId}:
        get:
            tags:
                - Institution Areas
            summary: Get Area Administratives By Area Administrative Id
            description: Multiple Area Administrative will be provided with comma separated strings
            parameters:
                - name: areaadministrativeId
                  in: path
                  description: Add Administrative id to filter
                  required: true
                  schema:
                      type: integer
                      format: int
            responses:
                "200":
                    description: successful operation
                    content:
                        application/json:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Area-Administratives-Id"
                        application/xml:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Area-Administratives-Id"
                "400":
                    description: Invalid status value

    /api/v4/institutions/localities/{localitiesId}:
        get:
            tags:
                - Institutions
            summary: Get Institution Localities By Its Id.
            description: Multiple Localities will be provided with comma separated strings
            parameters:
                - name: localitiesId
                  in: path
                  description: Add localities id to filter
                  required: true
                  schema:
                      type: integer
                      format: int
            responses:
                "200":
                    description: successful operation
                    content:
                        application/json:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Institution-Localities"
                        application/xml:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Institution-Localities"
                "400":
                    description: Invalid status value

    /api/v4/institutions/ownerships/{ownershipId}:
        get:
            tags:
                - Institutions
            summary: Get Institution Ownerships By Its Id.
            description: Multiple Ownerships will be provided with comma separated strings
            parameters:
                - name: ownershipId
                  in: path
                  description: Add Ownerships id to filter
                  required: true
                  schema:
                      type: integer
                      format: int
            responses:
                "200":
                    description: successful operation
                    content:
                        application/json:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Institution-Ownerships"
                        application/xml:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Institution-Ownerships"
                "400":
                    description: Invalid status value

    /api/v4/institutions/sectors/{sectorId}:
        get:
            tags:
                - Institutions
            summary: Get Institution Sectors By Its Id.
            description: Multiple Sectors will be provided with comma separated strings
            parameters:
                - name: sectorId
                  in: path
                  description: Add Sectors id to filter
                  required: true
                  schema:
                      type: integer
                      format: int
            responses:
                "200":
                    description: successful operation
                    content:
                        application/json:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Institution-Sectors"
                        application/xml:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Institution-Sectors"
                "400":
                    description: Invalid status value

    /api/v4/institutions/providers/{providersId}:
        get:
            tags:
                - Institutions
            summary: Get Institution Providers By Its Id.
            description: Multiple Providers will be provided with comma separated strings
            parameters:
                - name: providersId
                  in: path
                  description: Add Providers id to filter
                  required: true
                  schema:
                      type: integer
                      format: int
            responses:
                "200":
                    description: successful operation
                    content:
                        application/json:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Institution-Providers"
                        application/xml:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Institution-Providers"
                "400":
                    description: Invalid status value

    /api/v4/institutions/provider/{sectorId}:
        get:
            tags:
                - Institutions
            summary: Get Institution Providers By Its Sector Id.
            description: Multiple Providers will be provided with comma separated strings
            parameters:
                - name: sectorId
                  in: path
                  description: Add Providers id to filter
                  required: true
                  schema:
                      type: integer
                      format: int
            responses:
                "200":
                    description: successful operation
                    content:
                        application/json:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Institution-Providers"
                        application/xml:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Institution-Providers"
                "400":
                    description: Invalid status value

    /api/v4/institutions/types/{typesId}:
        get:
            tags:
                - Institutions
            summary: Get Institution Types By Its Sector Id.
            description: Multiple Types will be provided with comma separated strings
            parameters:
                - name: typesId
                  in: path
                  description: Add Types id to filter
                  required: true
                  schema:
                      type: integer
                      format: int
            responses:
                "200":
                    description: successful operation
                    content:
                        application/json:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Institution-Types"
                        application/xml:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Institution-Types"
                "400":
                    description: Invalid status value

    /api/v4/meal-benefits:
        get:
            tags:
                - Meals
            summary: Benefit Type Option
            description: Multiple Meal Benefits can be provided with comma separated strings
            parameters:
                - name: limit
                  in: header
                  description: This is to limit the number of result
                  required: false
                  schema:
                      type: integer
                - name: order
                  in: header
                  description: This is to sort the results
                  required: false
                  schema:
                      type: string
                - name: page
                  in: header
                  description: This is to display the results based on the page number
                  required: false
                  schema:
                      type: integer
            responses:
                "200":
                    description: successful operation
                    content:
                        application/json:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/meal-benefits"
                "400":
                    description: Invalid status value

    /api/v4/meal-programmes:
        get:
            tags:
                - Meals
            summary: Meal Programme List
            description: Meal Programme List
            parameters:
                - name: limit
                  in: header
                  description: This is to limit the number of result
                  required: false
                  schema:
                      type: integer
                - name: order
                  in: header
                  description: This is to sort the results
                  required: false
                  schema:
                      type: string
                - name: page
                  in: header
                  description: This is to display the results based on the page number
                  required: false
                  schema:
                      type: integer
            responses:
                "200":
                    description: successful operation
                    content:
                        application/json:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/meal-programmes"
                "400":
                    description: Invalid status value

    # POCOR-7394-S Ends

    /api/v4/institutions/students/meals:
        get:
            tags:
                - Meals
            summary: Students meal
            description: Get meals of students
            parameters:
                - name: limit
                  in: header
                  description: This is to limit the number of result
                  required: false
                  schema:
                      type: integer
            responses:
                "200":
                    description: successful operation
                    content:
                        application/json:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/student-meal"
                "400":
                    description: Invalid status value

    /api/v4/institutions/students/meal-benefits:
        post:
            tags:
                - Meals
            summary: Add Student meal benefit
            description: Mark Meal benefit (paid, free) for a Student on a particular date
            parameters:
                - name: student_id
                  in: query
                  description: Add student id to store
                  required: true
                  schema:
                      type: integer
                      format: int
                - name: academic_period_id
                  in: query
                  description: Add academic period id to store
                  required: true
                  schema:
                      type: integer
                      format: int
                - name: institution_id
                  in: query
                  description: Add institution id to store
                  required: true
                  schema:
                      type: integer
                      format: int
                - name: institution_classes_id
                  in: query
                  description: Add institution classes id to store
                  required: true
                  schema:
                      type: integer
                      format: int
                - name: date
                  in: query
                  description: Add date
                  required: true
                  schema:
                      type: string
                      format: varchar
                - name: meal_programms_id
                  in: query
                  description: Add meal program id
                  required: true
                  schema:
                      type: integer
                      format: int
                - name: meal_received_id
                  in: query
                  description: Add meal received id
                  required: true
                  schema:
                      type: integer
                      format: int
                - name: meal_benefit_id
                  in: query
                  description: Add meal benefit id
                  required: true
                  schema:
                      type: integer
                      format: int
            responses:
                "200":
                    description: successful operation
                "400":
                    description: Invalid status value

    /api/v4/institutions/{institutionId}/students/meals:
        get:
            tags:
                - Meals
            summary: Students meal by institution id
            description: Get meals of institution students
            parameters:
                - name: institutionId
                  in: path
                  description: This is to limit the number of result
                  required: true
                  schema:
                      type: integer
            responses:
                "200":
                    description: successful operation
                    content:
                        application/json:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/institution-student-meal"
                "400":
                    description: Invalid status value

    /api/v4/institutions/meals/distributions/:
        post:
            tags:
                - Meals
            summary: Add Meals
            description: Add meal
            parameters:
                - name: academic_period_id
                  in: query
                  description: Add academic period id to store
                  required: true
                  schema:
                      type: integer
                      format: int
                - name: institution_id
                  in: query
                  description: Add institution id to store
                  required: true
                  schema:
                      type: integer
                      format: int
                - name: date_received
                  in: query
                  description: Add date
                  required: true
                  schema:
                      type: string
                      format: varchar
                - name: quantity_received
                  in: query
                  description: number to quantity
                  required: true
                  schema:
                      type: integer
                      format: int
                - name: meal_rating_id
                  in: query
                  description: Add meal rating id
                  required: true
                  schema:
                      type: integer
                      format: int
                - name: delivery_status_id
                  in: query
                  description: Add meal delivery_status_id
                  required: true
                  schema:
                      type: integer
                      format: int
                - name: comment
                  in: query
                  description: Add comment
                  required: true
                  schema:
                      type: string
                      format: varchar
            responses:
                "200":
                    description: successful operation
                "400":
                    description: Invalid status value

    # POCOR-7546 starts

    /api/v4/assessments/education-grades:
        get:
            tags:
                - Assessments
            summary: Get Assessments Education Grades
            description: Multiple Education Grades will be provided with comma separated strings
            responses:
                "200":
                    description: successful operation
                    content:
                        application/json:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Assessments"
                        application/xml:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Assessments"
                "400":
                    description: Invalid status value
    /api/v4/assessments/items:
        get:
            tags:
                - Assessments
            summary: Get Assessments Items List
            description: Multiple Items List will be provided with comma separated strings
            parameters:
                - name: limit
                  in: header
                  description: This is to limit the number of result
                  required: false
                  schema:
                      type: integer
                - name: order
                  in: header
                  description: This is to sort the results
                  required: false
                  schema:
                      type: string
                - name: page
                  in: header
                  description: This is to display the results based on the page number
                  required: false
                  schema:
                      type: integer
            responses:
                "200":
                    description: successful operation
                    content:
                        application/json:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/AssessmentItem"
                        application/xml:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/AssessmentItem"
                "400":
                    description: Invalid status value
    /api/v4/assessments/periods:
        get:
            tags:
                - Assessments
            summary: Get Assessments Periods List
            description: Multiple Periods List will be provided with comma separated strings
            parameters:
                - name: limit
                  in: header
                  description: This is to limit the number of result
                  required: false
                  schema:
                      type: integer
                - name: order
                  in: header
                  description: This is to sort the results
                  required: false
                  schema:
                      type: string
                - name: page
                  in: header
                  description: This is to display the results based on the page number
                  required: false
                  schema:
                      type: integer
            responses:
                "200":
                    description: successful operation
                    content:
                        application/json:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/AssessmentPeriod"
                        application/xml:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/AssessmentPeriod"
                "400":
                    description: Invalid status value
    /api/v4/assessments/items/grading-types:
        get:
            tags:
                - Assessments
            summary: Get Assessments Item Grading Types List
            description: Multiple Item Grading Types List will be provided with comma separated strings
            parameters:
                - name: limit
                  in: header
                  description: This is to limit the number of result
                  required: false
                  schema:
                      type: integer
                - name: order
                  in: header
                  description: This is to sort the results
                  required: false
                  schema:
                      type: string
                - name: page
                  in: header
                  description: This is to display the results based on the page number
                  required: false
                  schema:
                      type: integer
            responses:
                "200":
                    description: successful operation
                    content:
                        application/json:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/AssessmentGradingTypes"
                        application/xml:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/AssessmentGradingTypes"
                "400":
                    description: Invalid status value
    /api/v4/assessments/grading-options:
        get:
            tags:
                - Assessments
            summary: Get Assessments Grading Options List
            description: Multiple Grading Options List will be provided with comma separated strings
            parameters:
                - name: limit
                  in: header
                  description: This is to limit the number of result
                  required: false
                  schema:
                      type: integer
                - name: order
                  in: header
                  description: This is to sort the results
                  required: false
                  schema:
                      type: string
                - name: page
                  in: header
                  description: This is to display the results based on the page number
                  required: false
                  schema:
                      type: integer
            responses:
                "200":
                    description: successful operation
                    content:
                        application/json:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/AssessmentGradingOptions"
                        application/xml:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/AssessmentGradingOptions"
                "400":
                    description: Invalid status value
    /api/v4/behaviours/categories:
        get:
            tags:
                - Institution Staff
            summary: Get Institution Behaviours Categories List
            description: Multiple Institution Behaviours Categories List will be provided with comma separated strings
            parameters:
                - name: limit
                  in: header
                  description: This is to limit the number of result
                  required: false
                  schema:
                      type: integer
                - name: order
                  in: header
                  description: This is to sort the results
                  required: false
                  schema:
                      type: string
                - name: page
                  in: header
                  description: This is to display the results based on the page number
                  required: false
                  schema:
                      type: integer
            responses:
                "200":
                    description: successful operation
                    content:
                        application/json:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/StaffBehaviourCategories"
                        application/xml:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/StaffBehaviourCategories"
                "400":
                    description: Invalid status value
    /api/v4/institutions/{institutionId}/students/{studentId}/behaviours:
        get:
            tags:
                - Institution students
            summary: Get Institution Student Behaviour
            description: Multiple Institution Student Behaviour will be provided with comma separated strings
            parameters:
                - name: institutionId
                  in: path
                  description: Add Institution id to filter
                  required: true
                  schema:
                      type: integer
                      format: int
                - name: studentId
                  in: path
                  description: Add student id to filter
                  required: true
                  schema:
                      type: integer
                      format: int
            responses:
                "200":
                    description: successful operation
                    content:
                        application/json:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/StudentBehaviours"
                        application/xml:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/StudentBehaviours"
                "400":
                    description: Invalid status value
    /api/v4/institutions/{institutionId}/institution-classes/{institutionClassId}/education-grades/{educationGradeId}/students:
        get:
            tags:
                - Institution students
            summary: Get Institution Class Grade Students List
            description: Multiple Institution Class Grade Students List will be provided with comma separated strings
            parameters:
                - name: institutionId
                  in: path
                  description: Add Institution id to filter
                  required: true
                  schema:
                      type: integer
                      format: int
                - name: institutionClassId
                  in: path
                  description: Add class id to filter
                  required: true
                  schema:
                      type: integer
                      format: int
                - name: educationGradeId
                  in: path
                  description: Add education grade id to filter
                  required: true
                  schema:
                      type: integer
                      format: int
            responses:
                "200":
                    description: successful operation
                    content:
                        application/json:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/InstitutionClasses"
                        application/xml:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/InstitutionClasses"
                "400":
                    description: Invalid status value
    /api/v4/institutions/{institutionId}/education-grades/{educationGradeId}/institution-subjects/students:
        get:
            tags:
                - Institution students
            summary: Get Institution Education Grade Students List
            description: Multiple Institution Education Grade Students List will be provided with comma separated strings
            parameters:
                - name: institutionId
                  in: path
                  description: Add Institution id to filter
                  required: true
                  schema:
                      type: integer
                      format: int
                - name: educationGradeId
                  in: path
                  description: Add education grade id to filter
                  required: true
                  schema:
                      type: integer
                      format: int
            responses:
                "200":
                    description: successful operation
                    content:
                        application/json:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/InstitutionSubjects"
                        application/xml:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/InstitutionSubjects"
                "400":
                    description: Invalid status value
    /api/v4/institutions/students/assessment-item-results:
        post:
            tags:
                - Assessments
            summary: Add Students Assessment Item Results
            description: Multiple values can be provided with comma separated strings
            parameters:
                - name: student_id
                  in: query
                  description: Add student id to store
                  required: true
                  schema:
                      type: integer
                      format: int
                - name: assessment_id
                  in: query
                  description: Add assessment id to store
                  required: true
                  schema:
                      type: integer
                      format: int
                - name: education_subject_id
                  in: query
                  description: Add education subject id to store
                  required: true
                  schema:
                      type: integer
                      format: int
                - name: education_grade_id
                  in: query
                  description: Add education grade id to store
                  required: true
                  schema:
                      type: integer
                      format: int
                - name: academic_period_id
                  in: query
                  description: Add academic period id to store
                  required: true
                  schema:
                      type: integer
                      format: int
                - name: assessment_period_id
                  in: query
                  description: Add assessment period id to store
                  required: true
                  schema:
                      type: integer
                      format: int
                - name: institution_id
                  in: query
                  description: Add institution id to store
                  required: true
                  schema:
                      type: integer
                      format: int
                - name: institution_classes_id
                  in: query
                  description: Add institution classes id to store
                  required: true
                  schema:
                      type: integer
                      format: int
                - name: marks
                  in: query
                  description: Add marks to store
                  required: false
                  schema:
                      type: integer
                      format: int
                - name: assessment_grading_option_id
                  in: query
                  description: Add assessment grading option id to store
                  required: false
                  schema:
                      type: integer
                      format: int
            responses:
                "200":
                    description: successful operation
                "400":
                    description: Something went wrong
    /api/v4/institutions/students/behaviours:
        post:
            tags:
                - Institution students
            summary: Add Students Behaviours
            description: Multiple values can be provided with comma separated strings
            parameters:
                - name: description
                  in: query
                  description: Add description to store
                  required: true
                  schema:
                      type: string
                      format: string
                - name: action
                  in: query
                  description: Add action to store
                  required: true
                  schema:
                      type: string
                      format: string
                - name: date_of_behaviour
                  in: query
                  description: Add date of behaviour to store
                  required: true
                  schema:
                      type: string
                      format: string
                - name: student_id
                  in: query
                  description: Add student id to store
                  required: true
                  schema:
                      type: integer
                      format: int
                - name: institution_id
                  in: query
                  description: Add institution id to store
                  required: true
                  schema:
                      type: integer
                      format: int
                - name: student_behaviour_category_id
                  in: query
                  description: Add student behaviour category id to store
                  required: true
                  schema:
                      type: integer
                      format: int
                - name: academic_period_id
                  in: query
                  description: Add academic period id to store
                  required: false
                  schema:
                      type: integer
                      format: int
                - name: status_id
                  in: query
                  description: Add status id to store
                  required: false
                  schema:
                      type: integer
                      format: int
                - name: assignee_id
                  in: query
                  description: Add assignee id to store
                  required: false
                  schema:
                      type: integer
                      format: int
                - name: student_behaviour_classification_id
                  in: query
                  description: Add student behaviour classification id to store
                  required: false
                  schema:
                      type: integer
                      format: int
            responses:
                "200":
                    description: successful operation
                "400":
                    description: Invalid status value
    /api/v4/institutions/{institutionId}/students/{studentId}/behaviours/{behaviourId}:
        delete:
            tags:
                - Institution students
            summary: Delete Students Behaviours
            description: Multiple values can be provided with comma separated strings
            parameters:
                - name: institutionId
                  in: path
                  description: Add Institution id to filter
                  required: true
                  schema:
                      type: integer
                      format: int
                - name: studentId
                  in: path
                  description: Add student id to filter
                  required: true
                  schema:
                      type: integer
                      format: int
                - name: behaviourId
                  in: path
                  description: Add behaviour id to filter
                  required: true
                  schema:
                      type: integer
                      format: int
            responses:
                "200":
                    description: successful operation
                "400":
                    description: Invalid status value

    # POCOR-7546 ends

    #POCOR-7728 starts
    /api/v4/area-administrative-levels/list:
        get:
            tags:
                - Area Administrative Levels List
            summary: Get Area Administrative Levels List List
            description: Area administrative levels list is provided to filter area administrative dropdown.
            responses:
                "200":
                    description: successful operation
                    content:
                        application/json:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Area-Administrative-Levels"
                        application/xml:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Assessments"
                "400":
                    description: Invalid status value

    /api/v4/area-administratives/list:
        get:
            tags:
                - Area Administrative List
            summary: Get Area Administrative List List
            description: Area administrative list is used on OpenEMIS Registration.
            parameters:
                - name: area_administrative_level_id
                  in: header
                  description: This is to filter area administrative list
                  required: false
                  schema:
                      type: integer
            responses:
                "200":
                    description: successful operation
                    content:
                        application/json:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Area-Administrative"
                        application/xml:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Assessments"
                "400":
                    description: Invalid status value

    #POCOR-7728 ends

    #POCOR-7749 start
    /api/v4/exams/{examId}:
        get:
            tags:
                - Examination
            summary: Examination details
            description: Get examination details by examination ID.
            parameters:
                - name: examId
                  in: path
                  description: filter the results by examId
                  required: true
                  schema:
                      type: integer
            responses:
                "200":
                    description: successful operation
                    content:
                        application/json:
                            schema:
                                $ref: "#/components/schemas/examination-detail"
                "404":
                    description: Examination not found

    /api/v4/exams/{examId}/centres/{centreId}:
        get:
            tags:
                - Examination
            summary: Centre Examination details
            description: Get centre examination by examination ID  and centreID.
            parameters:
                - name: examId
                  in: path
                  description: filter the results by examId
                  required: true
                  schema:
                      type: integer
                - name: centreId
                  in: path
                  description: filter the results by centreId
                  required: true
                  schema:
                      type: integer
            responses:
                "200":
                    description: successful operation
                    content:
                        application/json:
                            schema:
                                $ref: "#/components/schemas/centre-examination"
                "404":
                    description: Unsuccessful - Invalid parameters

    /api/v4/exams/{examId}/centres/{centreId}/students/{studentId}:
        get:
            tags:
                - Examination
            summary: Center Examination student details
            description: Get centre examination student by examination ID, centre ID and student ID.
            parameters:
                - name: examId
                  in: path
                  description: filter the results by examId
                  required: true
                  schema:
                      type: integer
                - name: centreId
                  in: path
                  description: filter the results by centreId
                  required: true
                  schema:
                      type: integer
                - name: studentId
                  in: path
                  description: filter the results by studentId
                  required: true
                  schema:
                      type: integer
            responses:
                "200":
                    description: successful operation
                    content:
                        application/json:
                            schema:
                                $ref: "#/components/schemas/centre-examination-student"
                "404":
                    description: Student not found
    #POCOR-7749 ends

    #POCOR-7968 start
    /api/v4/assessments/{assessment_id}/assessmentperiods:
        get:
            tags:
                - Assessment Periods
            summary: Assessment Periods
            description: This API is to get assessment period.
            parameters:
                - name: assessment_id
                  in: path
                  description: filter the results by assessment id
                  required: true
                  schema:
                      type: integer
            responses:
                "200":
                    description: successful operation
                    content:
                        application/json:
                            schema:
                                $ref: "#/components/schemas/Assessment-Period"
                "404":
                    description: Assessment period not found

    /api/v4/assessments/{assessment_id}:
        get:
            tags:
                - Assessments Data
            summary: Assessments Data
            description: This API is to get assessments data.
            parameters:
                - name: assessment_id
                  in: path
                  description: filter the results by assessment id
                  required: true
                  schema:
                      type: integer
            responses:
                "200":
                    description: successful operation
                    content:
                        application/json:
                            schema:
                                $ref: "#/components/schemas/Assessment-Data"
                "404":
                    description: Assessment data not found

    /assessments/{assessment_id}/assessmentitems:
        get:
            tags:
                - Assessments Item List
            summary: Assessments Item List
            description: This API is to get assessments item list.
            parameters:
                - name: assessment_id
                  in: path
                  description: filter the results by assessment id
                  required: true
                  schema:
                      type: integer
            responses:
                "200":
                    description: successful operation
                    content:
                        application/json:
                            schema:
                                $ref: "#/components/schemas/Assessment-Item"
                "404":
                    description: Assessment data not found

    /institutions/subject/student:
        get:
            tags:
                - Institutions subject student list
            summary: Institutions subject student list
            description: This API is to get institutions subject student list.
            responses:
                "200":
                    description: successful operation
                    content:
                        application/json:
                            schema:
                                $ref: "#/components/schemas/Institutions-Subject-Student"
                "404":
                    description: Assessment data not found

    #POCOR-7968 end

    #POCOR-7944 start

    /api/v4/institutions/save-student:
        post:
            tags:
                - Student Data Store
            summary: Add Students Details
            description: This API is used to store student details.
            parameters:
                - name: institution_id
                  in: query
                  description: Add institution id to store
                  required: true
                  schema:
                      type: integer
                      format: int
                - name: first_name
                  in: query
                  description: Add first name to store
                  required: true
                  schema:
                      type: string
                      format: string
                - name: middle_name
                  in: query
                  description: Add middle name to store
                  required: false
                  schema:
                      type: string
                      format: string
                - name: third_name
                  in: query
                  description: Add third name to store
                  required: false
                  schema:
                      type: string
                      format: string
                - name: last_name
                  in: query
                  description: Add last name to store
                  required: true
                  schema:
                      type: string
                      format: string
                - name: gender_id
                  in: query
                  description: Add gender id to store
                  required: true
                  schema:
                      type: integer
                      format: int
                - name: date_of_birth
                  in: query
                  description: Add date of birth to store
                  required: true
                  schema:
                      type: string
                      format: string
                - name: education_grade_id
                  in: query
                  description: Add education grade id to store
                  required: true
                  schema:
                      type: integer
                      format: int
                - name: academic_period_id
                  in: query
                  description: Add academic period id to store
                  required: true
                  schema:
                      type: integer
                      format: int
                - name: start_date
                  in: query
                  description: Add start date to store
                  required: true
                  schema:
                      type: string
                      format: string
                - name: end_date
                  in: query
                  description: Add end date to store
                  required: true
                  schema:
                      type: string
                      format: string
                - name: institution_class_id
                  in: query
                  description: Add institution class id to store
                  required: true
                  schema:
                      type: integer
                      format: int
                - name: custom
                  in: query
                  description: Add custom fields to store
                  required: false
                  schema:
                      type: string
                      format: string
            responses:
                "200":
                    description: successful operation
                "400":
                    description: Invalid status value

    /api/v4/institutions/save-staff:
        post:
            tags:
                - Staff Data Store
            summary: Add Staff Details
            description: This API is used to store staff details.
            parameters:
                - name: institution_id
                  in: query
                  description: Add institution id to store
                  required: true
                  schema:
                      type: integer
                      format: int
                - name: first_name
                  in: query
                  description: Add first name to store
                  required: true
                  schema:
                      type: string
                      format: string
                - name: middle_name
                  in: query
                  description: Add middle name to store
                  required: false
                  schema:
                      type: string
                      format: string
                - name: third_name
                  in: query
                  description: Add third name to store
                  required: false
                  schema:
                      type: string
                      format: string
                - name: last_name
                  in: query
                  description: Add last name to store
                  required: true
                  schema:
                      type: string
                      format: string
                - name: gender_id
                  in: query
                  description: Add gender id to store
                  required: true
                  schema:
                      type: integer
                      format: int
                - name: date_of_birth
                  in: query
                  description: Add date of birth to store
                  required: true
                  schema:
                      type: string
                      format: string
                - name: staff_position_grade_id
                  in: query
                  description: Add staff position grade id to store
                  required: true
                  schema:
                      type: integer
                      format: int
                - name: academic_period_id
                  in: query
                  description: Add academic period id to store
                  required: true
                  schema:
                      type: integer
                      format: int
                - name: start_date
                  in: query
                  description: Add start date to store
                  required: true
                  schema:
                      type: string
                      format: string
                - name: end_date
                  in: query
                  description: Add end date to store
                  required: true
                  schema:
                      type: string
                      format: string
                - name: staff_type_id
                  in: query
                  description: Add staff type id to store
                  required: true
                  schema:
                      type: integer
                      format: int
                - name: openemis_no
                  in: query
                  description: Add openemis no to store
                  required: false
                  schema:
                      type: integer
                      format: int
                - name: staff_id
                  in: query
                  description: Add staff id to store
                  required: false
                  schema:
                      type: integer
                      format: int
                - name: institution_position_id
                  in: query
                  description: Add institution position id to store
                  required: true
                  schema:
                      type: integer
                      format: int
                - name: fte
                  in: query
                  description: Add fte to store
                  required: false
                  schema:
                      type: integer
                      format: int
                - name: custom
                  in: query
                  description: Add custom fields to store
                  required: false
                  schema:
                      type: string
                      format: string
            responses:
                "200":
                    description: successful operation
                "400":
                    description: Invalid status value

    /api/v4/institutions/save-guardian:
        post:
            tags:
                - Guardian Data Store
            summary: Add Guardian Details
            description: This API is used to store guardian details.
            parameters:
                - name: first_name
                  in: query
                  description: Add first name to store
                  required: true
                  schema:
                      type: string
                      format: string
                - name: middle_name
                  in: query
                  description: Add middle name to store
                  required: false
                  schema:
                      type: string
                      format: string
                - name: third_name
                  in: query
                  description: Add third name to store
                  required: false
                  schema:
                      type: string
                      format: string
                - name: last_name
                  in: query
                  description: Add last name to store
                  required: true
                  schema:
                      type: string
                      format: string
                - name: gender_id
                  in: query
                  description: Add gender id to store
                  required: true
                  schema:
                      type: integer
                      format: int
                - name: date_of_birth
                  in: query
                  description: Add date of birth to store
                  required: true
                  schema:
                      type: string
                      format: string
                - name: student_id
                  in: query
                  description: Add student id to store
                  required: true
                  schema:
                      type: integer
                      format: int
                - name: guardian_relation_id
                  in: query
                  description: Add guardian relation id to store
                  required: false
                  schema:
                      type: integer
                      format: int
            responses:
                "200":
                    description: successful operation
                "400":
                    description: Invalid status value

    #POCOR-7944 end

    #POCOR-7943 start
    /api/v4/institutions/institution-classes/education-grades/class-attendance:
        delete:
            tags:
                - Class attendance delete
            summary: Delete class attendance
            description: This API is used to delete class attendance
            parameters:
                - name: institution_id
                  in: query
                  description: Add Institution id to filter
                  required: true
                  schema:
                      type: integer
                      format: int
                - name: academic_period_id
                  in: query
                  description: Add academic period id to filter
                  required: true
                  schema:
                      type: integer
                      format: int
                - name: institution_class_id
                  in: query
                  description: Add institution class id to filter
                  required: true
                  schema:
                      type: integer
                      format: int
                - name: education_grade_id
                  in: query
                  description: Add education grade id to filter
                  required: true
                  schema:
                      type: integer
                      format: int
                - name: date
                  in: query
                  description: Add date to filter
                  required: true
                  schema:
                      type: string
                      format: string
                - name: period
                  in: query
                  description: Add period to filter
                  required: false
                  schema:
                      type: integer
                      format: int
                - name: subject_id
                  in: query
                  description: Add subject id to filter
                  required: false
                  schema:
                      type: integer
                      format: int
            responses:
                "200":
                    description: successful operation
                "400":
                    description: Invalid status value

    /api/v4/institutions/student/{studentId}/absence:
        delete:
            tags:
                - Student absence delete
            summary: Delete student absence
            description: This API is used to delete student absence
            parameters:
                - name: studentId
                  in: path
                  description: Add student id to filter
                  required: true
                  schema:
                      type: integer
                - name: institution_id
                  in: query
                  description: Add institution id to filter
                  required: true
                  schema:
                      type: integer
                      format: int
                - name: academic_period_id
                  in: query
                  description: Add academic period id to filter
                  required: true
                  schema:
                      type: integer
                      format: int
                - name: institution_class_id
                  in: query
                  description: Add institution class id to filter
                  required: true
                  schema:
                      type: integer
                      format: int
                - name: education_grade_id
                  in: query
                  description: Add education grade id to filter
                  required: true
                  schema:
                      type: integer
                      format: int
                - name: date
                  in: query
                  description: Add date to filter
                  required: true
                  schema:
                      type: string
                      format: string
                - name: period
                  in: query
                  description: Add period to filter
                  required: false
                  schema:
                      type: integer
                      format: int
                - name: subject_id
                  in: query
                  description: Add subject id to filter
                  required: false
                  schema:
                      type: integer
                      format: int
            responses:
                "200":
                    description: successful operation
                "400":
                    description: Invalid status value

    #POCOR-7943 end

    #POCOR-7865 start
    /api/v4/schedules/timetables/{id}:
        get:
            tags:
                - Institution Time Table
            summary: Time Table details
            description: Get Time table details by time table Id.
            parameters:
                - name: id
                  in: path
                  description: filter the results by id
                  required: true
                  schema:
                      type: integer
            responses:
                "200":
                    description: successful operation
                    content:
                        application/json:
                            schema:
                                $ref: "#/components/schemas/time-table-detail"
                "500":
                    description: Something went wrong

    /api/v4/schedules/timetables/{id}/lessons:
        get:
            tags:
                - Institution Time Table
            summary: Lessons list
            description: Get Time table lessons details by time table Id.
            parameters:
                - name: id
                  in: path
                  description: filter the results by time table id
                  required: true
                  schema:
                      type: integer
            responses:
                "200":
                    description: successful operation
                    content:
                        application/json:
                            schema:
                                $ref: "#/components/schemas/time-table-lesson-detail"
                "500":
                    description: Something went wrong
    /api/v4/schedules/lessons/types:
        get:
            tags:
                - Institution Time Table
            summary: Lessons type list
            description: Get lessons type.
            responses:
                "200":
                    description: successful operation
                    content:
                        application/json:
                            schema:
                                $ref: "#/components/schemas/lesson-type"
                "500":
                    description: Something went wrong

    /api/v4/schedules/timetables/statuses:
        get:
            tags:
                - Institution Time Table
            summary: Time table status list
            description: Get status list.
            responses:
                "200":
                    description: successful operation
                    content:
                        application/json:
                            schema:
                                $ref: "#/components/schemas/time-table-status-list"
                "500":
                    description: Something went wrong

    /api/v4/weekdays:
        get:
            tags:
                - Institution Time Table
            summary: Working Days
            responses:
                "200":
                    description: successful operation
                    content:
                        application/json:
                            schema:
                                $ref: "#/components/schemas/working-days-of-week"
                "500":
                    description: Something went wrong

    /api/v4/schedules/timeslots/{intervalId}:
        get:
            tags:
                - Institution Time Table
            summary: Time slots
            description: Get Time slots by interval id.
            parameters:
                - name: intervalId
                  in: path
                  description: filter the results by intervalId
                  required: true
                  schema:
                      type: integer
            responses:
                "200":
                    description: successful operation
                    content:
                        application/json:
                            schema:
                                $ref: "#/components/schemas/time-slots-detail"
                "500":
                    description: Something went wrong

    /api/v4/institutions/classes/{id}/grades:
        get:
            tags:
                - Institutions
            summary: Grades List
            description: Get Instituion grade list by class id.
            parameters:
                - name: id
                  in: path
                  description: filter the results by intervalId
                  required: true
                  schema:
                      type: integer
            responses:
                "200":
                    description: successful operation
                    content:
                        application/json:
                            schema:
                                $ref: "#/components/schemas/institution-class-grade-list"
                "500":
                    description: Something went wrong

    /api/v4/institutions/{institutionId}/academicperiods/{academicYearId}/rooms:
        get:
            tags:
                - Institutions
            summary: Rooms List
            description: Get Instituion rooms list by institution id and academic year.
            parameters:
                - name: institutionId
                  in: path
                  description: filter the results by institutionId
                  required: true
                  schema:
                      type: integer
                - name: academicYearId
                  in: path
                  description: filter the results by academicYearId
                  required: true
                  schema:
                      type: integer
            responses:
                "200":
                    description: successful operation
                    content:
                        application/json:
                            schema:
                                $ref: "#/components/schemas/institution-room-list"
                "500":
                    description: Something went wrong

    /api/v4/institutions/classes/{id}/subjects:
        get:
            tags:
                - Institutions
            summary: Subject List
            description: Get Instituion class subjects list.
            parameters:
                - name: id
                  in: path
                  description: filter the results by id
                  required: true
                  schema:
                      type: integer
            responses:
                "200":
                    description: successful operation
                    content:
                        application/json:
                            schema:
                                $ref: "#/components/schemas/institution-class-subject-list"
                "500":
                    description: Something went wrong

    /api/v4/institutions/{institutionId}/schedules/timetables/lessons/{id}:
        delete:
            tags:
                - Institution Time Table
            summary: Delete lesson
            description: delete lesson by id.
            parameters:
                - name: institutionId
                  in: path
                  description: lesson id to be deleted
                  required: true
                  schema:
                      type: integer
                - name: id
                  in: path
                  description: lesson id to be deleted
                  required: true
                  schema:
                      type: integer
            responses:
                "200":
                    description: successful operation
                    content:
                        application/json:
                            schema:
                                $ref: "#/components/schemas/delete-lesson"
                "500":
                    description: Something went wrong

    /api/v4/chedules/timetables/lessons:
        post:
            tags:
                - Institution Time Table
            summary: Add lesson
            description: Multiple values can be provided with comma separated strings
            requestBody:
                required: true
                content:
                    application/json:
                        schema:
                            type: object
                            properties:
                                day_of_week:
                                    type: integer
                                institution_schedule_timeslot_id:
                                    type: integer
                                institution_schedule_timetable_id:
                                    type: integer
                                lesson_type:
                                    type: integer
                                schedule_non_curriculum_lesson:
                                    type: object
                                    properties:
                                        name:
                                            type: string
                                schedule_lesson_room:
                                    type: object
                                    properties:
                                        institution_schedule_lesson_detail_id:
                                            type: string
                                        institution_room_id:
                                            type: string
                                action_type:
                                    type: string
                                institution_id:
                                    type: integer
                            required:
                                - day_of_week
                                - institution_schedule_timeslot_id
                                - institution_schedule_timetable_id
                                - lesson_type
                                - schedule_non_curriculum_lesson
                                - schedule_lesson_room
                                - action_type
                                - institution_id
            responses:
                "200":
                    description: successful operation
                    content:
                        application/json:
                            schema:
                                $ref: "#/components/schemas/add-lesson"
                "400":
                    description: Invalid status value
    #POCOR-7865 end

    #POCOR-8025 starts
    /api/v4/nationalities:
        get:
            tags:
                - Nationalities list
            summary: Nationalities list
            description: This API is to fetch nationalities list.
            responses:
                "200":
                    description: successful operation
                    content:
                        application/json:
                            schema:
                                $ref: "#/components/schemas/Nationalities-List"
                "404":
                    description: Nationalities list found.
    #POCOR-8025 ends

    #POCOR-7856 start

    /api/v4/institutions/classes/reportcards/subject/comments:
        get:
            tags:
                - Report Card Subject Comments
            summary: Report Card Subject Comments
            description: Get Report Card Subject Comments List.
            responses:
                "200":
                    description: Report Card Subject Comments List Found.
                    content:
                        application/json:
                            schema:
                                $ref: "#/components/schemas/Report-Card-Subject-Comment"
                "400":
                    description: Invalid status value

    /api/v4/institutions/classes/reportcards/subject:
        get:
            tags:
                - Report Card Subject.
            summary: Report Card Subject.
            description: Get Report Card Subject List.
            responses:
                "200":
                    description: Report Card Subject List Found.
                    content:
                        application/json:
                            schema:
                                $ref: "#/components/schemas/Report-Card-Subject"
                "400":
                    description: Invalid status value

    #POCOR-7856 end

    #POCOR-7946 Start
    /api/v4/attendance-mark-types/education-grades:
        get:
            tags:
                - Education Grades.
            summary: Attendance mark types education grades.
            description: Get Attendance mark types education grades.
            responses:
                "200":
                    description: Education Grades List Found.
                    content:
                        application/json:
                            schema:
                                $ref: "#/components/schemas/Attendance-Mark-Types-Education-Grades"
                "400":
                    description: Invalid status value

    /api/v4/institutions/{institution_id}/classes/subjects:
        get:
            tags:
                - Institution Class Subjects.
            summary: Institution Class Subjects.
            description: Get Institution Class Subjects List.
            parameters:
                - name: institution_id
                  in: path
                  description: To filter the records.
                  required: true
                  schema:
                      type: integer
                      format: int
            responses:
                "200":
                    description: Institution Class Subjects List Found.
                    content:
                        application/json:
                            schema:
                                $ref: "#/components/schemas/Institution-Class-Subjects"
                "400":
                    description: Invalid status value

    /api/v4/institutions/classes/attendances:
        post:
            tags:
                - Add classes attendances.
            summary: Add classes attendances.
            description: Add classes attendances.
            parameters:
                - name: institution_id
                  in: query
                  description: To store institution id.
                  required: true
                  schema:
                      type: integer
                      format: int
                - name: academic_period_id
                  in: query
                  description: To store academic period id.
                  required: true
                  schema:
                      type: integer
                      format: int
                - name: education_grade_id
                  in: query
                  description: To store education grade id.
                  required: true
                  schema:
                      type: integer
                      format: int
                - name: institution_class_id
                  in: query
                  description: To store institution class id.
                  required: true
                  schema:
                      type: integer
                      format: int
                - name: date
                  in: query
                  description: To store date.
                  required: true
                  schema:
                      type: string
                      format: string
                - name: period
                  in: query
                  description: To store period.
                  required: false
                  schema:
                      type: integer
                      format: int
                - name: subject_id
                  in: query
                  description: To store subject id.
                  required: false
                  schema:
                      type: integer
                      format: int
                - name: created_user_id
                  in: query
                  description: To store created user id.
                  required: true
                  schema:
                      type: integer
                      format: int
                - name: created
                  in: query
                  description: To store created.
                  required: true
                  schema:
                      type: string
                      format: string
                - name: modified_user_id
                  in: query
                  description: To store modified user id.
                  required: false
                  schema:
                      type: integer
                      format: int
                - name: modified
                  in: query
                  description: To store modified.
                  required: false
                  schema:
                      type: string
                      format: string
            responses:
                "200":
                    description: Class attendances data added.
                "400":
                    description: Something went wrong.

    /api/v4/institutions/staff/attendances:
        post:
            tags:
                - Add staff attendances.
            summary: Add staff attendances.
            description: Add staff attendances.
            parameters:
                - name: institution_id
                  in: query
                  description: To store institution id.
                  required: true
                  schema:
                      type: integer
                      format: int
                - name: academic_period_id
                  in: query
                  description: To store academic period id.
                  required: true
                  schema:
                      type: integer
                      format: int
                - name: staff_id
                  in: query
                  description: To store staff id.
                  required: true
                  schema:
                      type: integer
                      format: int
                - name: date
                  in: query
                  description: To store date.
                  required: true
                  schema:
                      type: string
                      format: string
                - name: time_in
                  in: query
                  description: To store time in value.
                  required: false
                  schema:
                      type: string
                      format: string
                - name: time_out
                  in: query
                  description: To store time out value.
                  required: false
                  schema:
                      type: string
                      format: string
                - name: comment
                  in: query
                  description: To store comment.
                  required: false
                  schema:
                      type: string
                      format: string
                - name: created_user_id
                  in: query
                  description: To store created user id.
                  required: true
                  schema:
                      type: integer
                      format: int
                - name: created
                  in: query
                  description: To store created.
                  required: true
                  schema:
                      type: string
                      format: string
                - name: modified_user_id
                  in: query
                  description: To store modified user id.
                  required: false
                  schema:
                      type: integer
                      format: int
                - name: modified
                  in: query
                  description: To store modified.
                  required: false
                  schema:
                      type: string
                      format: string
            responses:
                "200":
                    description: Staff attendances data added.
                "400":
                    description: Something went wrong.

    /api/v4/institutions/staff:
        get:
            tags:
                - Institution Staff
            summary: Get All Staff for All Institution
            description: Multiple grades can be provided with comma separated strings
            responses:
                "200":
                    description: successful operation
                    content:
                        application/json:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Institution-Staff"
                        application/xml:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/Institution-Staff"
                "400":
                    description: Invalid status value
        post:
            tags:
                - Update staff details.
            summary: Update staff details.
            description: Update staff details.
            parameters:
                - name: id
                  in: query
                  description: To store id.
                  required: true
                  schema:
                      type: integer
                      format: int
                - name: first_name
                  in: query
                  description: To store first name.
                  required: true
                  schema:
                      type: string
                      format: string
                - name: last_name
                  in: query
                  description: To store last name.
                  required: true
                  schema:
                      type: string
                      format: string
                - name: gender_id
                  in: query
                  description: To store gender id.
                  required: true
                  schema:
                      type: integer
                      format: int
                - name: date_of_birth
                  in: query
                  description: To store gender id.
                  required: true
                  schema:
                      type: string
                      format: string
                - name: modified_user_id
                  in: query
                  description: To store modified user id.
                  required: false
                  schema:
                      type: integer
                      format: int
                - name: modified
                  in: query
                  description: To store modified.
                  required: false
                  schema:
                      type: string
                      format: string
            responses:
                "200":
                    description: Staff data updated.
                "400":
                    description: Something went wrong.
    #POCOR-7946 End

    #POCOR-8125/7854 Start

    /api/v4/institutions/classes/{classId}/grades:
        get:
            tags:
                - Student Attendance
            summary: Get grades via class id.
            description: Get grades via class id.
            parameters:
                - name: classId
                  in: path
                  description: Filter the records via class id.
                  required: true
                  schema:
                      type: integer
            responses:
                "200":
                    description: Institution Class grades Found.
                    content:
                        application/json:
                            schema:
                                $ref: "#/components/schemas/Institution-Class-Grades"
                "400":
                    description: Invalid status value

    /api/v4/grades/{gradeId}/attendance-types:
        get:
            tags:
                - Student Attendance
            summary: Get grade attendance types.
            description: Get grade attendance types.
            parameters:
                - name: gradeId
                  in: path
                  description: Filter the records via grade id.
                  required: true
                  schema:
                      type: integer
                  example: 206
                - name: academic_period_id
                  in: query
                  description: Filter the records via academic period id.
                  required: true
                  schema:
                      type: integer
                  example: 33
                - name: institution_class_id
                  in: query
                  description: Filter the records via institution class id.
                  required: true
                  schema:
                      type: integer
                  example: 604
                - name: day_id
                  in: query
                  description: Filter the records via day id.
                  required: true
                  schema:
                      type: string
                  example: "2024-02-02"
            responses:
                "200":
                    description: Attendance Types Found.
                    content:
                        application/json:
                            schema:
                                $ref: "#/components/schemas/Grade-Attendance-Types"
                "400":
                    description: Invalid status value
    /api/v4/institutions/{institutionId}/grades/{gradeId}/classes/{classId}/subjects:
        get:
            tags:
                - Student Attendance
            summary: Get Institution grade class subject list.
            description: Get Institution grade class subject list.
            parameters:
                - name: institutionId
                  in: path
                  description: Filter the records via institution id.
                  required: true
                  schema:
                      type: integer
                  example: 6
                - name: gradeId
                  in: path
                  description: Filter the records via grade id.
                  required: true
                  schema:
                      type: integer
                  example: 206
                - name: classId
                  in: path
                  description: Filter the records via class id.
                  required: true
                  schema:
                      type: integer
                  example: 591
                - name: academic_period_id
                  in: query
                  description: Filter the records via academic period id.
                  required: true
                  schema:
                      type: integer
                  example: 33
            responses:
                "200":
                    description: Attendance Types Found.
                    content:
                        application/json:
                            schema:
                                $ref: "#/components/schemas/Institution-Grade-Class-Subject"
                "400":
                    description: Invalid status value

    /api/v4/institutions/{institutionId}/grades/{gradeId}/classes/{classId}/student-attendance-types:
        get:
            tags:
                - Student Attendance
            summary: Get student attendance mark types.
            description: Get student attendance mark types.
            parameters:
                - name: institutionId
                  in: path
                  description: Filter the records via institution id.
                  required: true
                  schema:
                      type: integer
                  example: 6
                - name: gradeId
                  in: path
                  description: Filter the records via grade id.
                  required: true
                  schema:
                      type: integer
                  example: 206
                - name: classId
                  in: path
                  description: Filter the records via class id.
                  required: true
                  schema:
                      type: integer
                  example: 591
                - name: academic_period_id
                  in: query
                  description: Filter the records via academic period id.
                  required: true
                  schema:
                      type: integer
                  example: 33
                - name: day_id
                  in: query
                  description: Filter the records via day id (day id = -1 (All days)).
                  required: true
                  schema:
                      type: integer
                  example: -1
                - name: week_start_day
                  in: query
                  description: Filter the records via week start day id.
                  required: true
                  schema:
                      type: string
                  example: "2024-02-05"
                - name: week_end_day
                  in: query
                  description: Filter the records via week end day id.
                  required: true
                  schema:
                      type: string
                  example: "2024-02-11"
            responses:
                "200":
                    description: Student Attendance Mark Type Found.
                    content:
                        application/json:
                            schema:
                                $ref: "#/components/schemas/Student-Attendance-Mark"
                "400":
                    description: Invalid status value

    /api/v4/institutions/{institutionId}/grades/{gradeId}/classes/{classId}/student-attendances:
        get:
            tags:
                - Student Attendance
            summary: Get student attendances.
            description: Get student attendances.
            parameters:
                - name: institutionId
                  in: path
                  description: Filter the records via institution id.
                  required: true
                  schema:
                      type: integer
                  example: 6
                - name: gradeId
                  in: path
                  description: Filter the records via grade id.
                  required: true
                  schema:
                      type: integer
                  example: 206
                - name: classId
                  in: path
                  description: Filter the records via class id.
                  required: true
                  schema:
                      type: integer
                  example: 591
                - name: academic_period_id
                  in: query
                  description: Filter the records via academic period id.
                  required: true
                  schema:
                      type: integer
                  example: 33
                - name: day_id
                  in: query
                  description: Filter the records via day id  (day id = -1 (All days)).
                  required: true
                  schema:
                      type: integer
                  example: -1
                - name: week_start_day
                  in: query
                  description: Filter the records via week start day id.
                  required: true
                  schema:
                      type: string
                  example: "2024-02-05"
                - name: week_end_day
                  in: query
                  description: Filter the records via week end day id.
                  required: true
                  schema:
                      type: string
                  example: "2024-02-11"
                - name: attendance_period_id
                  in: query
                  description: Filter the records via attendance period id.
                  required: true
                  schema:
                      type: integer
                  example: 1
                - name: subject_id
                  in: query
                  description: Filter the records via subject id (Subject id = 0 (All subjects)).
                  required: true
                  schema:
                      type: integer
                  example: 0
                - name: week_id
                  in: query
                  description: Filter the records via week id.
                  required: true
                  schema:
                      type: integer
                  example: 6
            responses:
                "200":
                    description: Student Attendances Found.
                    content:
                        application/json:
                            schema:
                                $ref: "#/components/schemas/Student-Attendances"
                "400":
                    description: Invalid status value
    /api/v4/institutions/{institutionId}/grades/{gradeId}/classes/{classId}/student-attendance-marked:
        get:
            tags:
                - Student Attendance
            summary: Get student attendance marked.
            description: Get student attendance marked.
            parameters:
                - name: institutionId
                  in: path
                  description: Filter the records via institution id.
                  required: true
                  schema:
                      type: integer
                  example: 6
                - name: gradeId
                  in: path
                  description: Filter the records via grade id.
                  required: true
                  schema:
                      type: integer
                  example: 206
                - name: classId
                  in: path
                  description: Filter the records via class id.
                  required: true
                  schema:
                      type: integer
                  example: 591
                - name: academic_period_id
                  in: query
                  description: Filter the records via academic period id.
                  required: true
                  schema:
                      type: integer
                  example: 33
                - name: day_id
                  in: query
                  description: Filter the records via day id  (day id = -1 (All days)).
                  required: true
                  schema:
                      type: string
                  example: "2024-02-05"
                - name: attendance_period_id
                  in: query
                  description: Filter the records via attendance period id.
                  required: true
                  schema:
                      type: integer
                  example: 1
                - name: subject_id
                  in: query
                  description: Filter the records via subject id (Subject id = 0 (All subjects)).
                  required: true
                  schema:
                      type: integer
                  example: 0
            responses:
                "200":
                    description: Student Attendance Marked List Found.
                    content:
                        application/json:
                            schema:
                                $ref: "#/components/schemas/Student-Attendance-Marked"
                "400":
                    description: Invalid status value

    /api/v4/institutions/students/absences:
        post:
            tags:
                - Student Attendance
            summary: Add students absences.
            description: Add students absences.
            parameters:
                - name: institution_id
                  in: query
                  description: To store institution id.
                  required: true
                  schema:
                      type: integer
                      format: int
                - name: academic_period_id
                  in: query
                  description: To store academic period id.
                  required: true
                  schema:
                      type: integer
                      format: int
                - name: education_grade_id
                  in: query
                  description: To store education grade id.
                  required: true
                  schema:
                      type: integer
                      format: int
                - name: institution_class_id
                  in: query
                  description: To store institution class id.
                  required: true
                  schema:
                      type: integer
                      format: int
                - name: date
                  in: query
                  description: To store date.
                  required: true
                  schema:
                      type: string
                      format: string
                - name: period
                  in: query
                  description: To store period.
                  required: true
                  schema:
                      type: integer
                      format: int
                - name: subject_id
                  in: query
                  description: To store subject id.
                  required: true
                  schema:
                      type: integer
                      format: int
                - name: student_id
                  in: query
                  description: To store student id.
                  required: true
                  schema:
                      type: integer
                      format: int
                - name: absence_type_id
                  in: query
                  description: To store absence type id.
                  required: true
                  schema:
                      type: integer
                      format: int
                - name: comment
                  in: query
                  description: To store comment.
                  required: false
                  schema:
                      type: string
                      format: string
                - name: student_absence_reason_id
                  in: query
                  description: To store student absence reason id.
                  required: false
                  schema:
                      type: integer
                      format: integer
            responses:
                "200":
                    description: Students absences data added.
                "400":
                    description: Something went wrong.
        get:
            tags:
                - Institution students
            summary: Get Institution Students absences
            description: List of institution Students absences
            parameters:
                - name: academic_period_id
                  in: query
                  description: Add academic_period_id to filter
                  required: true
                  schema:
                      type: integer
                      format: int
                - name: page
                  in: query
                  description: Add page to filter
                  schema:
                      type: integer
                      format: int
                - name: limit
                  in: query
                  description: Add page to filter
                  schema:
                      type: integer
                      format: int
            responses:
                "200":
                    description: successful operation
                    content:
                        application/json:
                            schema:
                                $ref: "#/components/schemas/institution-students-absences"
                "400":
                    description: Invalid status value
    #POCOR-8125/7854 End

    # POCOR-7947 starts
    /api/v4/institutions/students:
        get:
            tags:
                - Institution students
            summary: Get Institution Students
            description: List of institution Students
            parameters:
                - name: academic_period_id
                  in: query
                  description: Add academic_period_id to filter
                  required: true
                  schema:
                      type: integer
                      format: int
                - name: page
                  in: query
                  description: Add page to filter
                  schema:
                      type: integer
                      format: int
                - name: limit
                  in: query
                  description: Add page to filter
                  schema:
                      type: integer
                      format: int
            responses:
                "200":
                    description: successful operation
                    content:
                        application/json:
                            schema:
                                $ref: "#/components/schemas/institution-students"
                "400":
                    description: Invalid status value
    /api/v4/institutions/{institutionId}/students:
        get:
            tags:
                - Institution students
            summary: Get Institution Students by institution Id
            description: List of institution Students by institution Id
            parameters:
                - name: institutionId
                  in: path
                  description: Add institutionId to filter
                  required: true
                  schema:
                      type: integer
                      format: int
                - name: academic_period_id
                  in: query
                  description: Add academic_period_id to filter
                  required: true
                  schema:
                      type: integer
                      format: int
                - name: page
                  in: query
                  description: Add page to filter
                  schema:
                      type: integer
                      format: int
                - name: limit
                  in: query
                  description: Add page to filter
                  schema:
                      type: integer
                      format: int
            responses:
                "200":
                    description: successful operation
                    content:
                        application/json:
                            schema:
                                $ref: "#/components/schemas/institution-students-by-institution-id"
                "400":
                    description: Invalid status value

    /api/v4/institutions/{institutionId}/students/{studentId}:
        get:
            tags:
                - Institution students
            summary: Get Institution Students by student id
            description: List of institution Students by student id
            parameters:
                - name: institutionId
                  in: path
                  description: Add institutionId to filter
                  required: true
                  schema:
                      type: integer
                      format: int
                - name: studentId
                  in: path
                  description: Add studentId to filter
                  required: true
                  schema:
                      type: integer
                      format: int
            responses:
                "200":
                    description: successful operation
                    content:
                        application/json:
                            schema:
                                $ref: "#/components/schemas/institution-student-detail"
                "400":
                    description: Invalid status value

    /api/v4/institutions/{institutionId}/students/{studentId}/absences:
        get:
            tags:
                - Institution students
            summary: Get Institution Students absences by student id
            description: List of institution Students absences by student id
            parameters:
                - name: institutionId
                  in: path
                  description: Add institutionId to filter
                  required: true
                  schema:
                      type: integer
                      format: int
                - name: studentId
                  in: path
                  description: Add studentId to filter
                  required: true
                  schema:
                      type: integer
                      format: int
            responses:
                "200":
                    description: successful operation
                    content:
                        application/json:
                            schema:
                                $ref: "#/components/schemas/institution-student-absences-details"
                "400":
                    description: Invalid status value

    /api/v4/institutions/{institutionId}/students/absences:
        get:
            tags:
                - Institution students
            summary: Get Institution Students absences by insititution id
            description: List of institution Students absences  by insititution id
            parameters:
                - name: institutionId
                  in: path
                  description: Add institutionId to filter
                  required: true
                  schema:
                      type: integer
                      format: int
                - name: academic_period_id
                  in: query
                  description: Add academic_period_id to filter
                  schema:
                      type: integer
                      format: int
                - name: page
                  in: query
                  description: Add page to filter
                  schema:
                      type: integer
                      format: int
                - name: limit
                  in: query
                  description: Add page to filter
                  schema:
                      type: integer
                      format: int
            responses:
                "200":
                    description: successful operation
                    content:
                        application/json:
                            schema:
                                $ref: "#/components/schemas/institution-students-absences-institution-id"
                "400":
                    description: Invalid status value
    # POCOR-7947 ends

    #POCOR-8104 Start

    /api/v4/user-types:
        get:
            tags:
                - Directory
            summary: Get user types list.
            description: Get user types list.
            responses:
                "200":
                    description: User types list found.
                    content:
                        application/json:
                            schema:
                                $ref: "#/components/schemas/User-Types"
                "400":
                    description: Something went wrong.

    /api/v4/users/generate-openemis-id:
        get:
            tags:
                - Directory
            summary: Generate openemis id.
            description: Generate openemis id.
            responses:
                "200":
                    description: Generate openemis id.
                    content:
                        application/json:
                            schema:
                                $ref: "#/components/schemas/Generate-Openemis-Id"
                "400":
                    description: Something went wrong.

    /api/v4/users/generate-password:
        get:
            tags:
                - Directory
            summary: Generate unique password.
            description: Generate unique password.
            responses:
                "200":
                    description: Generate unique password.
                    content:
                        application/json:
                            schema:
                                $ref: "#/components/schemas/Generate-Password"
                "400":
                    description: Something went wrong.

    /api/v4/contact-types:
        get:
            tags:
                - Directory
            summary: Contact types list found.
            description: Contact types list found.
            responses:
                "200":
                    description: Contact types list found.
                    content:
                        application/json:
                            schema:
                                $ref: "#/components/schemas/Contact-Types"
                "400":
                    description: Something went wrong.

    /api/v4/staff-custom-fields:
        get:
            tags:
                - Directory
            summary: Staff custom fields list found.
            description: Staff custom fields list found.
            responses:
                "200":
                    description: Staff custom fields list found.
                    content:
                        application/json:
                            schema:
                                $ref: "#/components/schemas/Staff-Custom-Fields"
                "400":
                    description: Something went wrong.

    /api/v4/field-options:
        get:
            tags:
                - Directory
            summary: Field Options Found.
            description: Field Options Found.
            responses:
                "200":
                    description: Field Options Found.
                    content:
                        application/json:
                            schema:
                                $ref: "#/components/schemas/Field-Options"
                "400":
                    description: Something went wrong.

    /api/v4/field-option/{fieldOptionId}:
        get:
            tags:
                - Directory
            summary: Field Options Data Found.
            description: Field Options Data Found.
            parameters:
                - name: fieldOptionId
                  in: path
                  description: Filter the records via field option id.
                  required: true
                  schema:
                      type: integer
                  example: 1
            responses:
                "200":
                    description: Field Options Data Found.
                    content:
                        application/json:
                            schema:
                                $ref: "#/components/schemas/Field-Option-Data"
                "400":
                    description: Something went wrong.

    /api/v4/users/basic-information:
        get:
            tags:
                - Directory
            summary: Field Options Data Found.
            description: Field Options Data Found.
            parameters:
                - name: first_name
                  in: query
                  description: Filter the records via first name.
                  required: true
                  schema:
                      type: string
                  example: "TestUser101"
                - name: last_name
                  in: query
                  description: Filter the records via last name.
                  required: true
                  schema:
                      type: string
                  example: "TestUser101"
                - name: date_of_birth
                  in: query
                  description: Filter the records via date of birth.
                  required: true
                  schema:
                      type: string
                  example: "17-04-2012"
                - name: user_type_id
                  in: query
                  description: Filter the records via user type id.
                  required: true
                  schema:
                      type: integer
                  example: 1
                - name: identity_number
                  in: query
                  description: Filter the records via identity number.
                  required: false
                  schema:
                      type: string
                  example: "ARKOV2951W"
            responses:
                "200":
                    description: User Data Found.
                    content:
                        application/json:
                            schema:
                                $ref: "#/components/schemas/Basic-Information"
                "400":
                    description: Something went wrong.

    /api/v4/relationship-types:
        get:
            tags:
                - Directory
            summary: Relationship Types Found.
            description: Relationship Types Found.
            responses:
                "200":
                    description: Relationship Types Found.
                    content:
                        application/json:
                            schema:
                                $ref: "#/components/schemas/Relationship-Types"
                "400":
                    description: Something went wrong.

    /api/v4/staff-types:
        get:
            tags:
                - Directory
            summary: Staff Types Found.
            description: Staff Types Found.
            responses:
                "200":
                    description: Staff Types Found.
                    content:
                        application/json:
                            schema:
                                $ref: "#/components/schemas/Staff-Types"
                "400":
                    description: Something went wrong.

    #POCOR-8104 End

    #POCOR-8078 Start
    /api/v4/meal-programmes/{mealProgammeId}:
        get:
            tags:
                - Student Meals
            summary: Meal Programme Data Found.
            description: Meal Programme Data Found.
            parameters:
                - name: mealProgammeId
                  in: path
                  description: Filter the records via meal progamme id.
                  required: true
                  schema:
                      type: string
                  example: 1
            responses:
                "200":
                    description: Meal Programme Data Found.
                    content:
                        application/json:
                            schema:
                                $ref: "#/components/schemas/Meal-Programme-Data"
                "400":
                    description: Something went wrong.

    /api/v4/meal-targets:
        get:
            tags:
                - Student Meals
            summary: Meal Targets List Found.
            description: Meal Targets List Found.
            responses:
                "200":
                    description: Meal Targets List Found.
                    content:
                        application/json:
                            schema:
                                $ref: "#/components/schemas/Meal-Targets"
                "400":
                    description: Something went wrong.

    /api/v4/meal-implementers:
        get:
            tags:
                - Student Meals
            summary: Meal Implementers List Found.
            description: Meal Implementers List Found.
            responses:
                "200":
                    description: Meal Implementers List Found.
                    content:
                        application/json:
                            schema:
                                $ref: "#/components/schemas/Meal-Implementers"
                "400":
                    description: Something went wrong.

    /api/v4/meal-nutritions:
        get:
            tags:
                - Student Meals
            summary: Meal Nutritions List Found.
            description: Meal Nutritions List Found.
            responses:
                "200":
                    description: Meal Nutritions List Found.
                    content:
                        application/json:
                            schema:
                                $ref: "#/components/schemas/Meal-Nutritions"
                "400":
                    description: Something went wrong.

    /api/v4/meal-ratings:
        get:
            tags:
                - Student Meals
            summary: Meal Ratings List Found.
            description: Meal Ratings List Found.
            responses:
                "200":
                    description: Meal Ratings List Found.
                    content:
                        application/json:
                            schema:
                                $ref: "#/components/schemas/Meal-Ratings"
                "400":
                    description: Something went wrong.

    /api/v4/meal-statuses:
        get:
            tags:
                - Student Meals
            summary: Meal Status Types List Found.
            description: Meal Status Types List Found.
            responses:
                "200":
                    description: Meal Status Types List Found.
                    content:
                        application/json:
                            schema:
                                $ref: "#/components/schemas/Meal-Status"
                "400":
                    description: Something went wrong.

    /api/v4/meal-food-types:
        get:
            tags:
                - Student Meals
            summary: Meal Food Types List Found.
            description: Meal Food Types List Found.
            responses:
                "200":
                    description: Meal Food Types List Found.
                    content:
                        application/json:
                            schema:
                                $ref: "#/components/schemas/Meal-Food-Types"
                "400":
                    description: Something went wrong.
    #POCOR-8078 End

    #POCOR-8076 start
    /api/v4/exams/{examId}/centres/{centreId}/subjects:
        get:
            tags:
                - Examination
            summary: Centre Examination subject details
            description: Get centre examination subject by examination ID  and centreID.
            parameters:
                - name: examId
                  in: path
                  description: filter the results by examId
                  required: true
                  schema:
                      type: integer
                - name: centreId
                  in: path
                  description: filter the results by centreId
                  required: true
                  schema:
                      type: integer
            responses:
                "200":
                    description: successful operation
                    content:
                        application/json:
                            schema:
                                $ref: "#/components/schemas/centre-examination-subject"
                "404":
                    description: Unsuccessful - Invalid parameters

    /api/v4/exams/{examId}/centres/{centreId}/subjects/{subjectId}/students:
        get:
            tags:
                - Examination
            summary: Centre Examination subject students list
            description: Get centre examination subject students by examination ID, centreID, subjectId.
            parameters:
                - name: examId
                  in: path
                  description: filter the results by examId
                  required: true
                  schema:
                      type: integer
                - name: centreId
                  in: path
                  description: filter the results by centreId
                  required: true
                  schema:
                      type: integer
                - name: subjectId
                  in: path
                  description: filter the results by subjectId
                  required: true
                  schema:
                      type: integer
            responses:
                "200":
                    description: successful operation
                    content:
                        application/json:
                            schema:
                                $ref: "#/components/schemas/centre-examination-subject-students"
                "404":
                    description: Unsuccessful - Invalid parameters.

    /api/v4/exams/student-subject-result:
        post:
            tags:
                - Examination
            summary: Add result
            description: Add student subject result
            requestBody:
                required: true
                content:
                    application/json:
                        schema:
                            type: object
                            properties:
                                marks:
                                    type: string
                                    description: The marks obtained by the student
                                    example: "56"
                                examination_grading_option_id:
                                    type: integer
                                    description: The ID of the grading option used for the examination
                                    example: 3
                                academic_period_id:
                                    type: integer
                                    description: The ID of the academic period
                                    example: 32
                                examination_id:
                                    type: integer
                                    description: The ID of the examination
                                    example: 3
                                education_subject_id:
                                    type: integer
                                    description: The ID of the education subject
                                    example: 60
                                examination_subject_id:
                                    type: integer
                                    description: The ID of the examination subject
                                    example: 10
                                examination_centre_id:
                                    type: integer
                                    description: The ID of the examination centre
                                    example: 23
                                institution_id:
                                    type: string
                                    description: The ID of the institution
                                    example: "6"
                                student_id:
                                    type: integer
                                    description: The ID of the student
                                    example: 10530
                            required:
                                - id
                                - name
            responses:
                "200":
                    description: Successful.
                    content:
                        application/json:
                            schema:
                                $ref: "#/components/schemas/centre-examination-subject-student-result"
                "404":
                    description: Unsuccessful - Invalid parameters

    #POCOR-8076 end

    #POCOR-8197 Start
    /api/v4/institutions/{institutionId}/grade-list:
        get:
            tags:
                - Institution Grades
            summary: Institution grades via institution id.
            description: Institution grades via institution id.
            parameters:
                - name: institutionId
                  in: path
                  description: Filter the records via institution id.
                  required: true
                  schema:
                      type: string
                  example: 6
            responses:
                "200":
                    description: Institution grades found.
                    content:
                        application/json:
                            schema:
                                $ref: "#/components/schemas/Institution-Grades-List"
                "400":
                    description: Something went wrong.
    #POCOR-8197 End

    #POCOR-7951 Start
    /api/v4/users:
        post:
            tags:
                - User Details
            summary: The APIs create a new user.
            description: The APIs create a new user.
            parameters:
                - name: first_name
                  in: query
                  description: User's first name.
                  required: true
                  schema:
                      type: string
                  example: "Test"
                - name: last_name
                  in: query
                  description: User's last name.
                  required: true
                  schema:
                      type: string
                  example: "User"
                - name: gender_id
                  in: query
                  description: User's gender id.
                  required: true
                  schema:
                      type: integer
                  example: "1"
                - name: date_of_birth
                  in: query
                  description: User's date of birth.
                  required: true
                  schema:
                      type: string
                  example: "1994-04-01"
            responses:
                "200":
                    description: User is created/updated successfully.
                "400":
                    description: Something went wrong.
        get:
            tags:
                - User Details
            summary: Get All User details
            description: Multiple values can be provided with comma separated strings
            responses:
                "200":
                    description: successful operation
                    content:
                        application/json:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/User-Details"
                        application/xml:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/User-Details"
                "400":
                    description: Invalid status value

    #POCOR-7951 End

    #POCOR-8153 Start
    /api/v4/system-configurations:
        get:
            tags:
                - System Configurations
            summary: System Configurations List Found.
            description: System Configurations List Found.
            responses:
                "200":
                    description: System Configurations List Found.
                    content:
                        application/json:
                            schema:
                                $ref: "#/components/schemas/System-Configurations"
                "400":
                    description: Something went wrong.

    /api/v4/system-configurations/{configId}:
        get:
            tags:
                - System Configurations
            summary: System Configurations Data Found.
            description: System Configurations Data Found.
            parameters:
                - name: configId
                  in: path
                  description: Filter the records via config id.
                  required: true
                  schema:
                      type: string
                  example: 1
            responses:
                "200":
                    description: System Configurations Data Found.
                    content:
                        application/json:
                            schema:
                                $ref: "#/components/schemas/System-Configurations"
                "400":
                    description: Something went wrong.
#POCOR-8153 End

components:
    schemas:
        Institutions:
            type: object
            required:
                - institutionId
            properties:
                institutionId:
                    type: integer
                    format: int
                    example: 10
                gradeId:
                    type: integer
                    format: int11
                    example: 10
                subjectId:
                    type: integer
                    format: int11
                    example: 198772
                shiftId:
                    type: integer
                    format: int11
                    example: 7
                staffId:
                    type: integer
                    format: int11
                    example: 10
                localeId:
                    type: integer
                    format: int11
                    example: 10
                institution_name:
                    type: object
                    format: varchar
                    example: "Avory Primary School"
                alternative_name:
                    type: object
                    format: varchar
                    example: "Avory Primary"
                institution_code:
                    type: object
                    format: varchar
                    example: 198772
                address:
                    type: object
                    format: varchar
                    example: "270 Duke Lane, City"
                postal_code:
                    type: integer
                    format: int11
                    example: 10231
                contact_person:
                    type: object
                    format: varchar
                    example: "Jane Woo"
                telephone:
                    type: integer
                    format: int11
                    example: 83948723
                fax:
                    type: integer
                    format: int11
                    example: 83948723
                email:
                    type: object
                    format: varchar
                    example: "contact@avoryprimary.com"
                website:
                    type: object
                    format: int11
                    example: "avoryprimary.com"
                date_opened:
                    type: integer
                    format: int11
                    example: "2000-01-01"
                year_opened:
                    type: integer
                    format: int11
                    example: "2000"
                date_closed:
                    type: object
                    format: varchar
                    example: "NULL"
                year_closed:
                    type: object
                    format: varchar
                    example: "NULL"
                longitude:
                    type: object
                    format: varchar
                    example: "76.7631591726293"
                latitude:
                    type: object
                    format: varchar
                    example: "-15.3786647475233"
                logo_name:
                    type: object
                    format: varchar
                    example: "image.png"
                logo_content:
                    type: object
                    format: varchar
                    example: "image.png"
                classification:
                    type: object
                    format: varchar
                    example: 1
                area_id:
                    type: integer
                    format: int
                    example: 1
                area_name:
                    type: object
                    format: varchar
                    example: "Endor"
                area_administrative_id:
                    type: integer
                    format: int11
                    example: 2
                area_administrative_name:
                    type: object
                    format: varchar
                    example: "District 1"
                institution_locality_id:
                    type: integer
                    format: varchar
                    example: 1
                institution_locality_name:
                    type: object
                    format: varchar
                    example: "Urban"
                institution_locality_international_code:
                    type: object
                    format: varchar
                    example: "Urban"
                institution_locality_national_code:
                    type: object
                    format: varchar
                    example: "Urban"
                institution_classification_id:
                    type: integer
                    format: int11
                    example: 2
                institution_classification_name:
                    type: object
                    format: varchar
                    example: "Academic"
                institution_type_id:
                    type: integer
                    format: int
                    example: 7
                institution_type_name:
                    type: object
                    format: varchar
                    example: "Primary"
                institution_type_international_code:
                    type: object
                    format: varchar
                    example: "Primary"
                institution_type_national_code:
                    type: integer
                    format: int11
                    example: "Primary"
                institution_ownership_id:
                    type: integer
                    format: int11
                    example: 1
                institution_ownership_international_code:
                    type: object
                    format: varchar
                    example: "Owned"
                institution_ownership_national_code:
                    type: object
                    format: varchar
                    example: "Owned"
                institution_status_id:
                    type: integer
                    format: int
                    example: 1
                institution_status_name:
                    type: object
                    format: varchar
                    example: "Active"
                institution_status_code:
                    type: object
                    format: varchar
                    example: "ACTIVE"
                institution_sector_id:
                    type: integer
                    format: int
                    example: 1
                institution_sector_name:
                    type: object
                    format: varchar
                    example: "Public"
                institution_sector_international_code:
                    type: object
                    format: varchar
                    example: "Public"
                institution_sector_national_code:
                    type: object
                    format: varchar
                    example: "Public"
                institution_provider_id:
                    type: integer
                    format: int11
                    example: 2
                institution_provider_name:
                    type: object
                    format: varchar
                    example: "MOE"
                institution_provider_international_code:
                    type: object
                    format: varchar
                    example: "MOE"
                institution_provider_national_code:
                    type: object
                    format: varchar
                    example: "MOE"
                institution_gender_id:
                    type: integer
                    format: int
                    example: 1
                institution_gender_name:
                    type: object
                    format: varchar
                    example: "Mixed"
                institution_gender_code:
                    type: object
                    format: varchar
                    example: "Mixed"
                security_group_id:
                    type: integer
                    format: int
                    example: 6
                modified_user_id:
                    type: integer
                    format: int
                    example: 1
                modified:
                    type: object
                    format: timestamp
                    example: "2020-01-01 12:00:00"
                created_user_id:
                    type: integer
                    format: int
                    example: 1
                created:
                    type: object
                    format: timestamp
                    example: "2000-01-01 12:00:00"
                status:
                    type: string
                    description: Order Status
                    example: approved
                    enum:
                        - placed
                        - approved
                        - delivered
                tags:
                    type: array
                    xml:
                        wrapped: true
                    items:
                        $ref: "#/components/schemas/Institutions"
                complete:
                    type: boolean
            xml:
                name: order
        Institution-Grades:
            type: object
            properties:
                institution_id:
                    type: integer
                    format: int11
                    example: 10
                grade_id:
                    type: integer
                    format: int11
                    example: 10
                # POCOR-7391
                student_id:
                    type: integer
                    format: int11
                    example: 10
                # POCOR-7391
                grade_name:
                    type: object
                    format: varchar
                    example: "Primary 1"
                order:
                    type: integer
                    format: int11
                    example: 10
                admission_age:
                    type: integer
                    format: int11
                    example: 7
                academic_period_id:
                    type: integer
                    format: int11
                    example: 10
                academic_period_name:
                    type: object
                    format: varchar
                    example: "2020"
                modified_user_id:
                    type: integer
                    format: int
                    example: 1
                modified:
                    type: object
                    format: timestamp
                    example: "2020-01-01 12:00:00"
                created_user_id:
                    type: integer
                    format: int
                    example: 1
                created:
                    type: object
                    format: timestamp
                    example: "2000-01-01 12:00:00"
                tags:
                    type: array
                    xml:
                        wrapped: true
                    items:
                        $ref: "#/components/schemas/Institution-Grades"
                complete:
                    type: boolean
            xml:
                name: order
        Institution-Classes:
            type: object
            properties:
                institution_id:
                    type: integer
                    format: int11
                    example: 10
                class_id:
                    type: integer
                    format: int11
                    example: 10
                class_name:
                    type: object
                    format: varchar
                    example: "Primary 1A"
                capacity:
                    type: integer
                    format: int11
                    example: 10
                total_students_female:
                    type: integer
                    format: int11
                    example: 10
                total_students_male:
                    type: object
                    format: varchar
                    example: "2020"
                total_students:
                    type: integer
                    format: int11
                    example: 10
                staff_id:
                    type: integer
                    format: int11
                    example: 10
                institution_shift_id:
                    type: object
                    format: varchar
                    example: "2020"
                academic_period_id:
                    type: integer
                    format: int11
                    example: 10
                academic_period_name:
                    type: integer
                    format: int11
                    example: 10
                grade:
                    type: array
                    xml:
                        wrapped: true
                    items:
                        $ref: "#/components/schemas/Education-Grades"
                subjects:
                    type: array
                    xml:
                        wrapped: true
                    items:
                        $ref: "#/components/schemas/Education-Subjects"
                secondary_teachers:
                    type: array
                    xml:
                        wrapped: true
                    items:
                        $ref: "#/components/schemas/staff_id"
                students:
                    type: array
                    xml:
                        wrapped: true
                    items:
                        $ref: "#/components/schemas/user_id"
                modified_user_id:
                    type: integer
                    format: int
                    example: 1
                modified:
                    type: object
                    format: timestamp
                    example: "2020-01-01 12:00:00"
                created_user_id:
                    type: integer
                    format: int
                    example: 1
                created:
                    type: object
                    format: timestamp
                    example: "2000-01-01 12:00:00"
        Institution-Subjects:
            type: object
            properties:
                institution_id:
                    type: integer
                    format: int11
                    example: 10
                subject_id:
                    type: integer
                    format: int11
                    example: 10
                subject_name:
                    type: object
                    format: varchar
                    example: "2020"
                total_female_students:
                    type: integer
                    format: int11
                    example: 10
                total_male_students:
                    type: integer
                    format: int11
                    example: 10
                education_grade_id:
                    type: object
                    format: varchar
                    example: "2020"
                education_grade_name:
                    type: integer
                    format: int11
                    example: 10
                education_subject_id:
                    type: integer
                    format: int11
                    example: 10
                education_subject_name:
                    type: object
                    format: varchar
                    example: "2020"
                academic_period_id:
                    type: integer
                    format: int11
                    example: 10
                academic_period_name:
                    type: integer
                    format: int11
                    example: 10
                classes:
                    type: array
                    xml:
                        wrapped: true
                    items:
                        $ref: "#/components/schemas/class_id"
                rooms:
                    type: integer
                    format: int11
                    example: 10
                staff:
                    type: array
                    xml:
                        wrapped: true
                    items:
                        $ref: "#/components/schemas/staff_id"
                students:
                    type: array
                    xml:
                        wrapped: true
                    items:
                        $ref: "#/components/schemas/user_id"
                modified_user_id:
                    type: integer
                    format: int
                    example: 1
                modified:
                    type: object
                    format: timestamp
                    example: "2020-01-01 12:00:00"
                created_user_id:
                    type: integer
                    format: int
                    example: 1
                created:
                    type: object
                    format: timestamp
                    example: "2000-01-01 12:00:00"
        Institution-Shifts:
            type: object
            properties:
                institution_id:
                    type: integer
                    format: int11
                    example: 10
                start_time:
                    type: integer
                    format: int11
                    example: 10
                end_time:
                    type: object
                    format: varchar
                    example: "2020"
                academic_period_name:
                    type: object
                    format: varchar
                    example: "2020"
                location_institution_id:
                    type: integer
                    format: int11
                    example: 10
                shift_option_id:
                    type: object
                    format: varchar
                    example: "2020"
                shift_option_name:
                    type: object
                    format: varchar
                    example: "2020"
                modified_user_id:
                    type: integer
                    format: int
                    example: 1
                modified:
                    type: object
                    format: timestamp
                    example: "2020-01-01 12:00:00"
                created_user_id:
                    type: integer
                    format: int
                    example: 1
                created:
                    type: object
                    format: timestamp
                    example: "2000-01-01 12:00:00"
        Institution-Areas:
            type: object
            properties:
                institution_id:
                    type: integer
                    format: int11
                    example: 10
                area_administrative:
                    type: array
                    xml:
                        wrapped: true
                    items:
                        $ref: "#/components/schemas/area_administrative"
                area_education:
                    type: array
                    xml:
                        wrapped: true
                    items:
                        $ref: "#/components/schemas/area_education"
                academic_period_name:
                    type: object
                    format: varchar
                    example: "2020"
                modified_user_id:
                    type: integer
                    format: int
                    example: 1
                modified:
                    type: object
                    format: timestamp
                    example: "2020-01-01 12:00:00"
                created_user_id:
                    type: integer
                    format: int
                    example: 1
                created:
                    type: object
                    format: timestamp
                    example: "2000-01-01 12:00:00"
        Institution-Summary:
            type: object
            properties:
                institution_id:
                    type: integer
                    format: int
                    example: 1
                institution_code:
                    type: string
                    format: int
                    example: 101
                academic_period_id:
                    type: integer
                    format: int
                    example: 111
                academic_period_name:
                    type: string
                    format: int
                    example: 2022-2023
                total_grades:
                    type: integer
                    format: int
                    example: 5
                total_lands:
                    type: integer
                    format: int
                    example: 1
                total_land_size:
                    type: integer
                    format: int
                    example: 400
                total_buildings:
                    type: integer
                    format: int
                    example: 2
                total_building_sizes:
                    type: integer
                    format: int
                    example: 100
                total_floors:
                    type: integer
                    format: int
                    example: 4
                total_floor_sizes:
                    type: integer
                    format: int
                    example: 100
                total_rooms:
                    type: integer
                    format: int
                    example: 20
                total_room_sizes:
                    type: integer
                    format: int
                    example: 50
                total_room_classrooms:
                    type: integer
                    format: int
                    example: 20
                total_room_classroom_sizes:
                    type: integer
                    format: int
                    example: 300
                total_room_non_classrooms:
                    type: integer
                    format: int
                    example: 20
                total_room_non_classroom_sizes:
                    type: integer
                    format: int
                    example: 300
                total_students_female:
                    type: integer
                    format: int
                    example: 50
                total_students_male:
                    type: integer
                    format: int
                    example: 50
                total_students:
                    type: integer
                    format: int
                    example: 100
                total_staff_non_teaching_female:
                    type: integer
                    format: int
                    example: 2
                total_staff_non_teaching_male:
                    type: integer
                    format: int
                    example: 2
                total_staff_non_teaching:
                    type: integer
                    format: int
                    example: 4
                total_staff_teaching_female:
                    type: integer
                    format: int
                    example: 2
                total_staff_teaching_male:
                    type: integer
                    format: int
                    example: 2
                total_staff_teaching:
                    type: integer
                    format: int
                    example: 4
                total_staff_female:
                    type: integer
                    format: int
                    example: 4
                total_staff_male:
                    type: integer
                    format: int
                    example: 4
                total_staff:
                    type: integer
                    format: int
                    example: 8
                total_classes_female:
                    type: integer
                    format: int
                    example: 2
                total_classes_male:
                    type: integer
                    format: int
                    example: 1
                total_classes_mixed:
                    type: integer
                    format: int
                    example: 3
                total_classes:
                    type: integer
                    format: int
                    example: 6
        Institution-Grade-Summary:
            type: object
            properties:
                institution_id:
                    type: integer
                    format: int
                    example: 1
                institution_code:
                    type: integer
                    format: int
                    example: 101
                academic_period_id:
                    type: integer
                    format: int
                    example: 111
                academic_period_name:
                    type: integer
                    format: int
                    example: 2022-2023
                grade_id:
                    type: integer
                    format: int
                    example: 1122
                grade_name:
                    type: integer
                    format: int
                    example: G10
                total_classes:
                    type: integer
                    format: int
                    example: 6
                total_classes_male:
                    type: integer
                    format: int
                    example: 1
                total_classes_female:
                    type: integer
                    format: int
                    example: 2
                total_classes_mixed:
                    type: integer
                    format: int
                    example: 3
                total_home_room_teachers:
                    type: integer
                    format: int
                    example: 2
                total_secondary_teachers:
                    type: integer
                    format: int
                    example: 4
                total_students:
                    type: integer
                    format: int
                    example: 100
                total_students_female:
                    type: integer
                    format: int
                    example: 50
                total_students_male:
                    type: integer
                    format: int
                    example: 50
        Room-Type-Summaries:
            type: object
            properties:
                institution_id:
                    type: integer
                    format: int
                    example: 1
                institution_code:
                    type: integer
                    format: int
                    example: 101
                academic_period_id:
                    type: integer
                    format: int
                    example: 111
                academic_period_name:
                    type: integer
                    format: int
                    example: 2022-2023
                infrastructure_level:
                    type: integer
                    format: int
                    example: Room
                infrastructure_type:
                    type: integer
                    format: int
                    example: Lab
                total_infrastructure_type:
                    type: integer
                    format: int
                    example: 3
        Institution-Student-Nationality-Summary:
            type: object
            properties:
                institution_id:
                    type: integer
                    format: int
                    example: 1
                institution_code:
                    type: string
                    format: varchar
                    example: 101
                academic_period_id:
                    type: integer
                    format: int
                    example: 111
                academic_period_name:
                    type: string
                    format: varchar
                    example: 2022-2023
                nationality_id:
                    type: integer
                    format: int
                    example: 112
                nationality_name:
                    type: string
                    format: varchar
                    example: Jordanian
                total_students:
                    type: integer
                    format: int
                    example: 33
                total_students_female:
                    type: integer
                    format: int
                    example: 16
                total_students_male:
                    type: integer
                    format: int
                    example: 17
        User-Details:
            type: object
            properties:
                id:
                    type: integer
                    format: int
                    example: 2
                username:
                    type: string
                    format: varchar
                    example: "admin"
                openemis_no:
                    type: string
                    format: varchar
                    example: "admin1"
                first_name:
                    type: string
                    format: varchar
                    example: "System"
                middle_name:
                    type: string
                    format: varchar
                    example: "Bin"
                third_name:
                    type: string
                    format: varchar
                    example: "Ali"
                last_name:
                    type: string
                    format: varchar
                    example: "Administrator"
                preferred_name:
                    type: string
                    format: varchar
                    example: "Ahmad"
                email:
                    type: string
                    format: varchar
                    example: "abc@gmail.com"
                Address:
                    type: string
                    format: varchar
                    example: "1 Long Road Brickland"
                postal_code:
                    type: string
                    format: varchar
                    example: "123123"
                address_area_id:
                    type: string
                    format: varchar
                    example: "1"
                birthplace_area_id:
                    type: string
                    format: varchar
                    example: "1"
                gender_id:
                    type: string
                    format: varchar
                    example: "1"
                gender_name:
                    type: string
                    format: varchar
                    example: "Female"
                date_of_birth:
                    type: string
                    format: varchar
                    example: "2022-08-10 12:00:00"
                date_of_death:
                    type: string
                    format: varchar
                    example: "2022-08-10 12:00:00"
                nationalities:
                    type: array
                    xml:
                        wrapped: true
                    items:
                        $ref: "#/components/schemas/nationalities"
                identities:
                    type: array
                    xml:
                        wrapped: true
                    items:
                        $ref: "#/components/schemas/identities"
                external_reference:
                    type: integer
                    format: int
                    example: 31
                super_admin:
                    type: integer
                    format: int
                    example: 1
                status:
                    type: string
                    format: varchar
                    example: "1"
                last_login:
                    type: string
                    format: varchar
                    example: "2022-08-10 12:00:00"
                photo_name:
                    type: object
                    format: object
                    example: "image.png"
                preferred_language:
                    type: string
                    format: varchar
                    example: "en"
                is_student:
                    type: integer
                    format: int
                    example: 0
                is_staff:
                    type: integer
                    format: int
                    example: 0
                is_guardian:
                    type: integer
                    format: int
                    example: 0
        Institution-Staff:
            type: object
            properties:
                institution_id:
                    type: integer
                    format: int
                    example: 31
                institution_code:
                    type: integer
                    format: int
                    example: 101
                fte:
                    type: integer
                    format: int
                    example: 1
                start_date:
                    type: string
                    format: datetime
                    example: 2022-08-10 12:00:00
                start_year:
                    type: integer
                    format: int
                    example: 2022
                end_date:
                    type: string
                    format: datetime
                    example: 2022-08-10 12:00:00
                end_year:
                    type: integer
                    format: int
                    example: 2022
                staff_id:
                    type: integer
                    format: int
                    example: 533
                staff_type_id:
                    type: integer
                    format: int
                    example: 3
                staff_type_name:
                    type: string
                    format: varchar
                    example: "Permanent"
                staff_status_id:
                    type: integer
                    format: int
                    example: 2
                staff_status_name:
                    type: string
                    format: varchar
                    example: "Assigned"
                institution_position_id:
                    type: integer
                    format: int
                    example: 192
                institution_position_name:
                    type: string
                    format: varchar
                    example: "Principal"
                security_group_user_id:
                    type: integer
                    format: int
                    example: 1
                modified_user_id:
                    type: integer
                    format: int
                    example: 1
                modified:
                    type: object
                    format: timestamp
                    example: "2020-01-01 12:00:00"
                created_user_id:
                    type: integer
                    format: int
                    example: 1
                created:
                    type: object
                    format: timestamp
                    example: "2000-01-01 12:00:00"
        Institution-Positions:
            type: object
            properties:
                institution_id:
                    type: integer
                    format: int
                    example: 1
                status_id:
                    type: integer
                    format: int
                    example: 29
                status_name:
                    type: string
                    format: varchar
                    example: "Active"
                position_id:
                    type: integer
                    format: int
                    example: 3
                position_no:
                    type: string
                    format: varchar
                    example: "K0001-1522277303"
                staff_position_title_id:
                    type: integer
                    format: int
                    example: 240
                staff_position_title_name:
                    type: string
                    format: varchar
                    example: "Principal - Non-Teaching"
                staff_position_grade_id:
                    type: integer
                    format: int
                    example: 1
                staff_position_grade_name:
                    type: string
                    format: varchar
                    example: "Pay Scale 1"
                assignee_id:
                    type: integer
                    format: int
                    example: 8805
                is_homeroom:
                    type: integer
                    format: int
                    example: 0
                modified_user_id:
                    type: integer
                    format: int
                    example: 1
                modified:
                    type: object
                    format: timestamp
                    example: "2020-01-01 12:00:00"
                created_user_id:
                    type: integer
                    format: int
                    example: 1
                created:
                    type: object
                    format: timestamp
                    example: "2000-01-01 12:00:00"
                tags:
                    type: array
                    xml:
                        wrapped: true
                    items:
                        $ref: "#/components/schemas/Institution-Grades"
                complete:
                    type: boolean
            xml:
                name: order
        Locale-Content-Details:
            type: object
            properties:
                id:
                    type: integer
                    format: int
                    example: 2
                translation:
                    type: string
                    format: varchar
                    example: "North"
                locale_content_id:
                    type: integer
                    format: integer
                    example: "2"
                locale_content_name:
                    type: string
                    format: varchar
                    example: "شمال"
                locale_id:
                    type: integer
                    format: int
                    example: "1"
                locale_name:
                    type: string
                    format: varchar
                    example: "arabic"
                modified_user_id:
                    type: integer
                    format: int
                    example: 1
                modified:
                    type: object
                    format: timestamp
                    example: "2020-01-01 12:00:00"
                created_user_id:
                    type: integer
                    format: int
                    example: 1
                created:
                    type: object
                    format: timestamp
                    example: "2000-01-01 12:00:00"
                tags:
                    type: array
                    xml:
                        wrapped: true
                    items:
                        $ref: "#/components/schemas/Institution-Grades"
                complete:
                    type: boolean
            xml:
                name: order
        Education-System:
            type: object
            properties:
                id:
                    type: integer
                    format: int11
                    example: 1
                level_name:
                    type: string
                    format: varchar
                    example: "National Education System"
                academic_period_id:
                    type: integer
                    format: int11
                    example: 10
                academic_period_name:
                    type: string
                    format: varchar
                    example: "2022-2023"
                order:
                    type: integer
                    format: int11
                    example: 1
                visible:
                    type: integer
                    format: int11
                    example: 1
                modified_user_id:
                    type: integer
                    format: int11
                    example: 1
                modified:
                    type: string
                    format: varchar
                    example: "2023-01-01 12:00:00"
                created_user_id:
                    type: integer
                    format: int11
                    example: 1
                created:
                    type: integer
                    format: int11
                    example: "2023-01-01 12:00:00"
                levels:
                    type: array
                    xml:
                        wrapped: true
                    items:
                        $ref: "#/components/schemas/Education-Levels"
        Education-Levels:
            type: object
            properties:
                level_id:
                    type: integer
                    format: int11
                    example: 10
                name:
                    type: string
                    format: varchar
                    example: "Primary Education Level"
                order:
                    type: integer
                    format: int11
                    example: 1
                visible:
                    type: integer
                    format: int11
                    example: 1
                modified_user_id:
                    type: integer
                    format: int11
                    example: 1
                modified:
                    type: string
                    format: varchar
                    example: "2023-01-01 12:00:00"
                created_user_id:
                    type: integer
                    format: int11
                    example: 1
                created:
                    type: integer
                    format: int11
                    example: "2023-01-01 12:00:00"
                levels:
                    type: array
                    xml:
                        wrapped: true
                    items:
                        $ref: "#/components/schemas/Education-Cycles"
        Education-Cycles:
            type: object
            properties:
                id:
                    type: integer
                    format: int11
                    example: 10
                name:
                    type: string
                    format: varchar
                    example: "Primary Education Cycle"
                order:
                    type: integer
                    format: int11
                    example: 1
                visible:
                    type: integer
                    format: int11
                    example: 1
                modified_user_id:
                    type: integer
                    format: int11
                    example: 1
                modified:
                    type: string
                    format: varchar
                    example: "2023-01-01 12:00:00"
                created_user_id:
                    type: integer
                    format: int11
                    example: 1
                created:
                    type: integer
                    format: int11
                    example: "2023-01-01 12:00:00"
                levels:
                    type: array
                    xml:
                        wrapped: true
                    items:
                        $ref: "#/components/schemas/Education-Programmes"
        Education-Programmes:
            type: object
            properties:
                id:
                    type: integer
                    format: int11
                    example: 10
                name:
                    type: string
                    format: varchar
                    example: "Primary Education Cycle"
                order:
                    type: integer
                    format: int11
                    example: 1
                visible:
                    type: integer
                    format: int11
                    example: 1
                modified_user_id:
                    type: integer
                    format: int11
                    example: 1
                modified:
                    type: string
                    format: varchar
                    example: "2023-01-01 12:00:00"
                created_user_id:
                    type: integer
                    format: int11
                    example: 1
                created:
                    type: integer
                    format: int11
                    example: "2023-01-01 12:00:00"
                levels:
                    type: array
                    xml:
                        wrapped: true
                    items:
                        $ref: "#/components/schemas/Education-Grades"
        Education-Grades:
            type: object
            properties:
                grade_id:
                    type: integer
                    format: int11
                    example: 10
        Education-Subjects:
            type: object
            properties:
                subject_id:
                    type: integer
                    format: int11
                    example: 10
        staff_id:
            type: object
            properties:
                staff_id:
                    type: integer
                    format: int11
                    example: 10
        user_id:
            type: object
            properties:
                user_id:
                    type: integer
                    format: int11
                    example: 10
        class_id:
            type: object
            properties:
                user_id:
                    type: integer
                    format: int11
                    example: 10
        area_administrative:
            type: object
            properties:
                area_administrative_id:
                    type: integer
                    format: int11
                    example: 10
                area_administrative_code:
                    type: integer
                    format: int11
                    example: 10
                area_administrative_name:
                    type: integer
                    format: int11
                    example: 10
                area_administrative_child:
                    type: array
                    xml:
                        wrapped: true
                    items:
                        $ref: "#/components/schemas/area_administrative_child"
        area_administrative_child:
            type: object
            properties:
                area_administrative_id:
                    type: integer
                    format: int11
                    example: 10
                area_administrative_code:
                    type: integer
                    format: int11
                    example: 10
                area_administrative_name:
                    type: integer
                    format: int11
                    example: 10
                area_administrative_child:
                    type: array
                    xml:
                        wrapped: true
                    items:
                        $ref: "#/components/schemas/area_administrative_child"
        area_education:
            type: object
            properties:
                class_id:
                    type: integer
                    format: int11
                    example: 10
                area_education:
                    type: integer
                    format: int11
                    example: 10
                area_education_code:
                    type: integer
                    format: int11
                    example: 10
                area_education_name:
                    type: integer
                    format: int11
                    example: 10
                area_education_child:
                    type: array
                    xml:
                        wrapped: true
                    items:
                        $ref: "#/components/schemas/area_education_child"
        area_education_child:
            type: object
            properties:
                class_id:
                    type: integer
                    format: int11
                    example: 10
                area_education:
                    type: integer
                    format: int11
                    example: 10
                area_education_code:
                    type: integer
                    format: int11
                    example: 10
                area_education_name:
                    type: integer
                    format: int11
                    example: 10
                area_education_child:
                    type: array
                    xml:
                        wrapped: true
                    items:
                        $ref: "#/components/schemas/area_education_child"
        nationalities:
            type: object
            properties:
                preferred:
                    type: integer
                    format: int11
                    example: 1
                nationality_id:
                    type: integer
                    format: int11
                    example: 1
                nationality_name:
                    type: string
                    format: varchar
                    example: "Jordanian"
                security_user_id:
                    type: integer
                    format: int11
                    example: 1
                modified_user_id:
                    type: integer
                    format: int
                    example: 1
                modified:
                    type: object
                    format: timestamp
                    example: "2020-01-01 12:00:00"
                created_user_id:
                    type: integer
                    format: int
                    example: 1
                created:
                    type: object
                    format: timestamp
                    example: "2000-01-01 12:00:00"
        identities:
            type: object
            properties:
                identity_type_id:
                    type: integer
                    format: int
                    example: 1
                identity_type_name:
                    type: string
                    format: varchar
                    example: National Number
                number:
                    type: integer
                    format: int
                    example: 222
                issue_date:
                    type: integer
                    format: int
                    example: 2022-08-10 12:00:00
                expiry_date:
                    type: integer
                    format: int
                    example: 2022-08-10 12:00:00
                issue_location:
                    type: string
                    format: varchar
                    example: Jordan
                nationality_id:
                    type: integer
                    format: int
                    example: 1
                comments:
                    type: string
                    format: varchar
                    example: No comment
                security_user_id:
                    type: integer
                    format: int
                    example: 111
                modified_user_id:
                    type: integer
                    format: int
                    example: 1
                modified:
                    type: object
                    format: timestamp
                    example: "2020-01-01 12:00:00"
                created_user_id:
                    type: integer
                    format: int
                    example: 1
                created:
                    type: object
                    format: timestamp
                    example: "2000-01-01 12:00:00"

        Assessment-Item-Results:
            type: object
            properties:
                academic_period_id:
                    type: integer
                    format: int
                    example: 27
                assessment_grading_option_id:
                    type: integer
                    format: int
                    example: 5
                assessment_id:
                    type: integer
                    format: int
                    example: 20
                assessment_period_id:
                    type: integer
                    format: int
                    example: 11
                education_grade_id:
                    type: integer
                    format: int
                    example: 139
                education_subject_id:
                    type: integer
                    format: int
                    example: 37
                institution_id:
                    type: integer
                    format: int
                    example: 6
                marks:
                    type: integer
                    format: int
                    example: 59.00
                student_id:
                    type: integer
                    format: int
                    example: 1130

        Address-Area-Level:
            type: object
            properties:
                id:
                    type: integer
                    format: int
                    example: 13
                name:
                    type: string
                    format: varchar
                    example: "North"
                tags:
                    type: array
                    xml:
                        wrapped: true
                    items:
                        $ref: "#/components/schemas/Institution-Grades"
                complete:
                    type: boolean
            xml:
                name: order

        login:
            type: object
            properties:
                message:
                    type: string
                    format: varchar
                    example: "Logged In successfully"
                data:
                    type: object
                    format: varchar
                    example: "{token:heyJoeXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOlwvXC9kZW1vLm9wZW5lbWlzLm9yZ1wvY29yZVwvYXBpXC92NFwvbG9naW4iLCJpYXQiOjE2NzQ3MDQ1NjUsImV4cCI6MTY3NDcwODE2NSwibmJmIjoxNjc0NzA0NTY1LCJqdGkiOiJBUElEaGtWak9FUHdzUXc2Iiwic3ViIjoyLCJwcnYiOiJlMjE0OWY2ZjU0YWJlZjFjN2Q2NjMzYTUzYzkyMmM1NzgxODA1ZThjIn0.7Qcz1wiCG9LDxxVOUgGAgkTyOCHqfQ5861QGg6xuPOI}"

        Institution-Subjects-Staff:
            type: object
            properties:
                education_systems_name:
                    type: string
                    format: varchar
                    example: "National Education System 2023"
                education_levels_name:
                    type: string
                    format: varchar
                    example: "Primary Education"
                education_cycles_name:
                    type: string
                    format: varchar
                    example: "Primary - General"
                education_programmes_code:
                    type: string
                    format: varchar
                    example: "Primary"
                education_programmes_name:
                    type: string
                    format: varchar
                    example: "Primary"
                education_grades_code:
                    type: string
                    format: varchar
                    example: "Primary 1"
                education_grades_name:
                    type: string
                    format: varchar
                    example: "Primary 1"
                education_subjects_code:
                    type: string
                    format: varchar
                    example: "SSMC"
                education_subjects_name:
                    type: string
                    format: varchar
                    example: "Social Studies"
                institutions_id:
                    type: integer
                    format: int
                    example: 6
                institutions_code:
                    type: string
                    format: varchar
                    example: "P1002"
                institutions_name:
                    type: string
                    format: varchar
                    example: "Avory Primary School"
                institution_classes_name:
                    type: string
                    format: varchar
                    example: "Primary 1-A"
                academic_periods_name:
                    type: string
                    format: varchar
                    example: "YR2023"
                academic_periods_code:
                    type: string
                    format: varchar
                    example: "2023"
                institution_subjects_id:
                    type: integer
                    format: int
                    example: 4516
                institution_subjects_name:
                    type: string
                    format: varchar
                    example: "Social Studies"
                security_users_openemis_no_subject_teachers:
                    type: string
                    format: varchar
                    example: "1522952429"
                security_users_openemis_no_students:
                    type: string
                    format: varchar
                    example: ""
                tags:
                    type: array
                    xml:
                        wrapped: true
                    items:
                        $ref: "#/components/schemas/Institution-Grades"
                complete:
                    type: boolean
            xml:
                name: order
        #POCOR-7394-S starts
        User-Genders:
            type: "object"
            properties:
                id:
                    type: integer
                    format: int11
                    example: 1
                name:
                    type: string
                    format: varchar
                    example: Male
                code:
                    type: string
                    format: varchar
                    example: M
                order:
                    type: integer
                    format: int11
                    example: 1
                created_user_id:
                    type: integer
                    format: int
                    example: 1
                created:
                    type: object
                    format: timestamp
                    example: "2023-01-01 12:00:00"
        Institutions-Genders:
            type: "object"
            properties:
                id:
                    type: integer
                    format: int11
                    example: 1
                name:
                    type: string
                    format: varchar
                    example: Mixed
                code:
                    type: string
                    format: varchar
                    example: X
                order:
                    type: integer
                    format: int11
                    example: 1
                created_user_id:
                    type: integer
                    format: int
                    example: 1
                created:
                    type: object
                    format: timestamp
                    example: "2023-01-01 12:00:00"
        Area-Administratives:
            type: object
            properties:
                id:
                    type: integer
                    format: int11
                    example: 1
                code:
                    type: string
                    format: varchar
                    example: world
                name:
                    type: string
                    format: varchar
                    example: world
                is_main_country:
                    type: integer
                    format: int11
                    example: 0
                parent_id:
                    type: integer
                    format: int11
                    example:
                lft:
                    type: integer
                    format: int11
                    example: 1
                rght:
                    type: integer
                    format: int11
                    example: 450
                area_administrative_level_id:
                    type: integer
                    format: int11
                    example: 6
                order:
                    type: integer
                    format: int11
                    example: 1
                visible:
                    type: integer
                    format: int11
                    example: 1
                modified_user_id:
                    type: integer
                    format: int
                    example: 0
                modified:
                    type: object
                    format: timestamp
                    example: "2023-01-01 12:00:00"
                created_user_id:
                    type: integer
                    format: int
                    example: 1
                created:
                    type: object
                    format: timestamp
                    example: "2023-01-01 12:00:00"
                area_administrative_level:
                    type: object
                    format: varchar
                    example: "{...}"
        Area-Administratives-Id:
            type: object
            properties:
                id:
                    type: integer
                    format: int11
                    example: 1
                code:
                    type: string
                    format: varchar
                    example: world
                name:
                    type: string
                    format: varchar
                    example: world
                is_main_country:
                    type: integer
                    format: int11
                    example: 0
                parent_id:
                    type: integer
                    format: int11
                    example:
                lft:
                    type: integer
                    format: int11
                    example: 1
                rght:
                    type: integer
                    format: int11
                    example: 450
                area_administrative_level_id:
                    type: integer
                    format: int11
                    example: 6
                order:
                    type: integer
                    format: int11
                    example: 1
                visible:
                    type: integer
                    format: int11
                    example: 1
                modified_user_id:
                    type: integer
                    format: int
                    example: 0
                modified:
                    type: object
                    format: timestamp
                    example: "2023-01-01 12:00:00"
                created_user_id:
                    type: integer
                    format: int
                    example: 1
                created:
                    type: object
                    format: timestamp
                    example: "2023-01-01 12:00:00"
        Institution-Localities:
            type: object
            properties:
                id:
                    type: integer
                    format: int11
                    example: 1
                name:
                    type: string
                    format: varchar
                    example: urban
                order:
                    type: integer
                    format: int11
                    example: 2
                visible:
                    type: integer
                    format: int11
                    example: 1
                editable:
                    type: integer
                    format: int11
                    example: 1
                default:
                    type: integer
                    format: int11
                    example: 0
                international_code:
                    type: string
                    format: varchar
                    example:
                national_code:
                    type: string
                    format: varchar
                    example:
                modified_user_id:
                    type: integer
                    format: int
                    example: 0
                modified:
                    type: object
                    format: timestamp
                    example: "2023-01-01 12:00:00"
                created_user_id:
                    type: integer
                    format: int
                    example: 1
                created:
                    type: object
                    format: timestamp
                    example: "2023-01-01 12:00:00"
        Institution-Ownerships:
            type: object
            properties:
                id:
                    type: integer
                    format: int11
                    example: 1
                name:
                    type: string
                    format: varchar
                    example: Customary (Disputed)
                order:
                    type: integer
                    format: int11
                    example: 3
                visible:
                    type: integer
                    format: int11
                    example: 1
                editable:
                    type: integer
                    format: int11
                    example: 1
                default:
                    type: integer
                    format: int11
                    example: 0
                international_code:
                    type: string
                    format: varchar
                    example:
                national_code:
                    type: string
                    format: varchar
                    example:
                modified_user_id:
                    type: integer
                    format: int
                    example:
                modified:
                    type: object
                    format: timestamp
                    example:
                created_user_id:
                    type: integer
                    format: int
                    example: 1
                created:
                    type: object
                    format: timestamp
                    example: "2023-01-01 12:00:00"
        Institution-Sectors:
            type: object
            properties:
                id:
                    type: integer
                    format: int11
                    example: 1
                name:
                    type: string
                    format: varchar
                    example: Public
                order:
                    type: integer
                    format: int11
                    example: 1
                visible:
                    type: integer
                    format: int11
                    example: 1
                editable:
                    type: integer
                    format: int11
                    example: 1
                default:
                    type: integer
                    format: int11
                    example: 0
                international_code:
                    type: string
                    format: varchar
                    example:
                national_code:
                    type: string
                    format: varchar
                    example:
                modified_user_id:
                    type: integer
                    format: int
                    example: 2
                modified:
                    type: object
                    format: timestamp
                    example: "2023-01-01 12:00:00"
                created_user_id:
                    type: integer
                    format: int
                    example: 1
                created:
                    type: object
                    format: timestamp
                    example: "2023-01-01 12:00:00"
        Institution-Providers:
            type: object
            properties:
                id:
                    type: integer
                    format: int11
                    example: 1
                name:
                    type: string
                    format: varchar
                    example: Religious
                order:
                    type: integer
                    format: int11
                    example: 2
                visible:
                    type: integer
                    format: int11
                    example: 1
                editable:
                    type: integer
                    format: int11
                    example: 1
                default:
                    type: integer
                    format: int11
                    example: 0
                institution_sector_id:
                    type: integer
                    format: int11
                    example: 2
                international_code:
                    type: string
                    format: varchar
                    example:
                national_code:
                    type: string
                    format: varchar
                    example:
                modified_user_id:
                    type: integer
                    format: int
                    example: 2
                modified:
                    type: object
                    format: timestamp
                    example: "2023-01-01 12:00:00"
                created_user_id:
                    type: integer
                    format: int
                    example: 1
                created:
                    type: object
                    format: timestamp
                    example: "2023-01-01 12:00:00"
        Institution-Types:
            type: object
            properties:
                id:
                    type: integer
                    format: int11
                    example: 1
                name:
                    type: string
                    format: varchar
                    example: Pre-primary
                order:
                    type: integer
                    format: int11
                    example: 1
                visible:
                    type: integer
                    format: int11
                    example: 1
                editable:
                    type: integer
                    format: int11
                    example: 1
                default:
                    type: integer
                    format: int11
                    example: 0
                international_code:
                    type: string
                    format: varchar
                    example:
                national_code:
                    type: string
                    format: varchar
                    example:
                modified_user_id:
                    type: integer
                    format: int
                    example:
                modified:
                    type: object
                    format: timestamp
                    example:
                created_user_id:
                    type: integer
                    format: int
                    example: 2
                created:
                    type: object
                    format: timestamp
                    example: "2023-01-01 12:00:00"

        #POCOR-7394-S ends

        #POCOR-7368 starts
        InstitutionTextbooks:
            type: object
            properties:
                id:
                    type: integer
                    format: int11
                    example: 1
                code:
                    type: string
                    format: varchar
                    example: MA001-1
                comment:
                    type: string
                    format: varchar
                    example: ""
                textbook_status_id:
                    type: integer
                    format: int11
                    example: 1
                textbook_condition_id:
                    type: integer
                    format: int11
                    example: 1
                institution_id:
                    type: integer
                    format: int11
                    example: 6
                academic_period_id:
                    type: integer
                    format: int11
                    example: 28
                education_grade_id:
                    type: integer
                    format: int11
                    example: 121
                education_subject_id:
                    type: integer
                    format: int11
                    example: 91
                security_user_id:
                    type: integer
                    format: int11
                    example: 10551
                textbook_id:
                    type: integer
                    format: int11
                    example: 19
                modified_user_id:
                    type: integer
                    format: int
                    example:
                modified:
                    type: object
                    format: timestamp
                    example:
                created_user_id:
                    type: integer
                    format: int
                    example: 2
                created:
                    type: object
                    format: timestamp
                    example: "2023-01-01 12:00:00"
        Textbooks:
            type: object
            properties:
                id:
                    type: integer
                    format: int11
                    example: 1
                code:
                    type: string
                    format: varchar
                    example: MA001-1
                title:
                    type: string
                    format: varchar
                    example: "Large Print Language Arts Textbook"
                author:
                    type: string
                    format: varchar
                    example: "Steven Janson"
                publisher:
                    type: string
                    format: varchar
                    example: "Khan"
                year_published:
                    type: integer
                    format: int11
                    example: 2000
                ISBN:
                    type: string
                    format: varchar
                    example: "15345645"
                expiry_date:
                    type: integer
                    format: int11
                    example:
                academic_period_id:
                    type: integer
                    format: int11
                    example: 27
                education_grade_id:
                    type: integer
                    format: int11
                    example: 76
                education_subject_id:
                    type: integer
                    format: int11
                    example: 6
                textbook_dimension_id:
                    type: integer
                    format: int11
                    example: 1
                modified_user_id:
                    type: integer
                    format: int
                    example:
                modified:
                    type: object
                    format: timestamp
                    example:
                created_user_id:
                    type: integer
                    format: int
                    example: 2
                created:
                    type: object
                    format: timestamp
                    example: "2023-01-01 12:00:00"
        TextbookDimensions:
            type: object
            properties:
                id:
                    type: integer
                    format: int11
                    example: 1
                name:
                    type: string
                    format: varchar
                    example: "50mmx76mm"
                order:
                    type: integer
                    format: int11
                    example: 1
                visible:
                    type: integer
                    format: int11
                    example: 1
                editable:
                    type: integer
                    format: int11
                    example: 1
                default:
                    type: integer
                    format: int11
                    example: 0
                international_code:
                    type: string
                    format: varchar
                    example:
                national_code:
                    type: string
                    format: varchar
                    example:
                modified_user_id:
                    type: integer
                    format: int
                    example:
                modified:
                    type: object
                    format: timestamp
                    example:
                created_user_id:
                    type: integer
                    format: int
                    example: 2
                created:
                    type: object
                    format: timestamp
                    example: "2023-01-01 12:00:00"
        TextbookConditions:
            type: object
            properties:
                id:
                    type: integer
                    format: int11
                    example: 1
                name:
                    type: string
                    format: varchar
                    example: new
                order:
                    type: integer
                    format: int11
                    example: 1
                visible:
                    type: integer
                    format: int11
                    example: 1
                editable:
                    type: integer
                    format: int11
                    example: 1
                default:
                    type: integer
                    format: int11
                    example: 0
                international_code:
                    type: string
                    format: varchar
                    example:
                national_code:
                    type: string
                    format: varchar
                    example:
                modified_user_id:
                    type: integer
                    format: int
                    example:
                modified:
                    type: object
                    format: timestamp
                    example:
                created_user_id:
                    type: integer
                    format: int
                    example: 2
                created:
                    type: object
                    format: timestamp
                    example: "2023-01-01 12:00:00"
        TextbookStatuses:
            type: object
            properties:
                id:
                    type: integer
                    format: int11
                    example: 1
                code:
                    type: string
                    format: varchar
                    example: AVAILABLE
                name:
                    type: string
                    format: varchar
                    example: Available
                order:
                    type: integer
                    format: int11
                    example: 1
                visible:
                    type: integer
                    format: int11
                    example: 1
                editable:
                    type: integer
                    format: int11
                    example: 1
                default:
                    type: integer
                    format: int11
                    example: 0
                international_code:
                    type: string
                    format: varchar
                    example:
                national_code:
                    type: string
                    format: varchar
                    example:
                modified_user_id:
                    type: integer
                    format: int
                    example:
                modified:
                    type: object
                    format: timestamp
                    example:
                created_user_id:
                    type: integer
                    format: int
                    example: 2
                created:
                    type: object
                    format: timestamp
                    example: "2023-01-01 12:00:00"

        #POCOR-7368 ends

        #POCOR-7546 starts
        Assessments:
            type: object
            properties:
                id:
                    type: integer
                    format: int11
                    example: 17
                code:
                    type: string
                    format: varchar
                    example: A1
                name:
                    type: string
                    format: varchar
                    example: Assessment - Kindergarten 1
                description:
                    type: string
                    format: varchar
                    example:
                academic_period_id:
                    type: integer
                    format: int11
                    example: 27
                education_grade_id:
                    type: integer
                    format: int11
                    example: 136
                modified_user_id:
                    type: integer
                    format: int
                    example:
                modified:
                    type: object
                    format: timestamp
                    example:
                created_user_id:
                    type: integer
                    format: int
                    example: 2
                created:
                    type: object
                    format: timestamp
                    example: "2023-01-01 12:00:00"
        AssessmentItem:
            type: object
            properties:
                id:
                    type: integer
                    format: int11
                    example: 01cbd28f-38cb-464b-b369-3a94a8bc396f
                weight:
                    type: integer
                    format: int11
                    example: 0.00
                classification:
                    type: string
                    format: varchar
                    example:
                assessment_id:
                    type: integer
                    format: int11
                    example: 33
                education_subject_id:
                    type: integer
                    format: int11
                    example: 83
                education_subject_name:
                    type: string
                    format: varchar
                    example: CA-Creative Arts
                modified_user_id:
                    type: integer
                    format: int
                    example:
                modified:
                    type: object
                    format: timestamp
                    example:
                created_user_id:
                    type: integer
                    format: int
                    example: 2
                created:
                    type: object
                    format: timestamp
                    example: "2023-01-01 12:00:00"
        AssessmentPeriod:
            type: object
            properties:
                id:
                    type: integer
                    format: int11
                    example: 2
                code:
                    type: string
                    format: varchar
                    example: FYAK2
                name:
                    type: string
                    format: varchar
                    example: Final Year Assessment K2
                start_date:
                    type: object
                    format: timestamp
                    example: "2023-01-01"
                end_date:
                    type: object
                    format: timestamp
                    example: "2023-01-01"
                date_enabled:
                    type: object
                    format: timestamp
                    example: "2023-01-01"
                date_disabled:
                    type: object
                    format: timestamp
                    example: "2023-01-01"
                weight:
                    type: integer
                    format: int11
                    example: 100
                academic_term:
                    type: string
                    format: varchar
                    example:
                assessment_id:
                    type: integer
                    format: int11
                    example: 16
                education_grade_id:
                    type: integer
                    format: int11
                    example: 171
                education_grade_code:
                    type: string
                    format: varchar
                    example: "K2"
                education_grade_name:
                    type: string
                    format: varchar
                    example: "K2"
                modified_user_id:
                    type: integer
                    format: int
                    example:
                modified:
                    type: object
                    format: timestamp
                    example:
                created_user_id:
                    type: integer
                    format: int
                    example: 2
                created:
                    type: object
                    format: timestamp
                    example: "2023-01-01 12:00:00"
        AssessmentGradingTypes:
            type: object
            properties:
                id:
                    type: integer
                    format: int11
                    example: 2
                code:
                    type: integer
                    format: int11
                    example: 001
                name:
                    type: string
                    format: varchar
                    example: Marks Grading Scale
                pass_mark:
                    type: integer
                    format: int11
                    example: 50
                max:
                    type: integer
                    format: int11
                    example: 100
                result_type:
                    type: string
                    format: varchar
                    example: MARKS
                assessment_grading_options:
                    type: string
                    format: varchar
                    example: "id: 2
                        code: A
                        name: Excellent
                        description: null
                        min: '80.00'
                        max: '100.00'
                        order: 1
                        visible: 1
                        assessment_grading_type_id: 2
                        modified_user_id: 1
                        modified: '2015-07-10 19:24:17'
                        created_user_id: 1
                        created: '2015-07-10 19:24:17'"
                modified_user_id:
                    type: integer
                    format: int
                    example:
                modified:
                    type: object
                    format: timestamp
                    example:
                created_user_id:
                    type: integer
                    format: int
                    example: 2
                created:
                    type: object
                    format: timestamp
                    example: "2023-01-01 12:00:00"
        AssessmentGradingOptions:
            type: object
            properties:
                id:
                    type: integer
                    format: int11
                    example: 2
                code:
                    type: string
                    format: varchar
                    example: A
                name:
                    type: string
                    format: varchar
                    example: Excellent
                min:
                    type: integer
                    format: int11
                    example: 80
                max:
                    type: integer
                    format: int11
                    example: 100
                order:
                    type: integer
                    format: int11
                    example: 1
                visible:
                    type: integer
                    format: int11
                    example: 1
                modified_user_id:
                    type: integer
                    format: int
                    example:
                modified:
                    type: object
                    format: timestamp
                    example:
                created_user_id:
                    type: integer
                    format: int
                    example: 2
                created:
                    type: object
                    format: timestamp
                    example: "2023-01-01 12:00:00"
        StaffBehaviourCategories:
            type: object
            properties:
                id:
                    type: integer
                    format: int11
                    example: 368
                name:
                    type: string
                    format: varchar
                    example: Repeated Tardiness
                order:
                    type: integer
                    format: int11
                    example: 22
                visible:
                    type: integer
                    format: int11
                    example: 1
                editable:
                    type: integer
                    format: int11
                    example: 1
                default:
                    type: integer
                    format: int11
                    example: 0
                international_code:
                    type: string
                    format: varchar
                    example:
                national_code:
                    type: string
                    format: varchar
                    example:
                modified_user_id:
                    type: integer
                    format: int
                    example: 2
                modified:
                    type: object
                    format: timestamp
                    example: "2023-01-01 12:00:00"
                created_user_id:
                    type: integer
                    format: int
                    example: 2
                created:
                    type: object
                    format: timestamp
                    example: "2023-01-01 12:00:00"
        StudentBehaviours:
            type: object
            properties:
                id:
                    type: integer
                    format: int11
                    example: 2
                description:
                    type: string
                    format: varchar
                    example: Copying of fellow learner's homework . Student has copied a fellow learner's homework
                action:
                    type: string
                    format: varchar
                    example: Disciplinary actions have been taken
                date_of_behaviour:
                    type: object
                    format: date
                    example: "2023-01-01"
                time_of_behaviour:
                    type: object
                    format: date
                    example: "2023-01-01"
                academic_period_id:
                    type: integer
                    format: int11
                    example: 27
                student_id:
                    type: integer
                    format: int11
                    example: 1177
                editable:
                    type: integer
                    format: int11
                    example: 1
                institution_id:
                    type: integer
                    format: int11
                    example: 6
                status_id:
                    type: integer
                    format: int11
                    example: 128
                student_behaviour_category_id:
                    type: integer
                    format: int11
                    example: 237
                assignee_id:
                    type: integer
                    format: int11
                    example:
                student_behaviour_classification_id:
                    type: integer
                    format: int11
                    example:
                modified_user_id:
                    type: integer
                    format: int
                    example: 2
                modified:
                    type: object
                    format: timestamp
                    example: "2023-01-01 12:00:00"
                created_user_id:
                    type: integer
                    format: int
                    example: 2
                created:
                    type: object
                    format: timestamp
                    example: "2023-01-01 12:00:00"
        InstitutionClasses:
            type: object
            properties:
                institution_class_id:
                    type: integer
                    format: int11
                    example: 539
                institution_class_name:
                    type: string
                    format: varchar
                    example: Primary 1-D
                institution_id:
                    type: integer
                    format: int11
                    example: 6
                student_id:
                    type: integer
                    format: int11
                    example: "{13658,
                        13659,
                        14079,
                        14080,
                        14084,
                        14085}"
        InstitutionSubjects:
            type: object
            properties:
                institution_subject_id:
                    type: integer
                    format: int11
                    example: 129
                institution_subject_name:
                    type: string
                    format: varchar
                    example: Social Studies
                education_subject_code:
                    type: string
                    format: varchar
                    example: SSMC
                education_subject_name:
                    type: string
                    format: varchar
                    example: Social Studies
                institution_id:
                    type: integer
                    format: int11
                    example: 6
                student_id:
                    type: integer
                    format: int11
                    example: "{1180,
                        1181,
                        1182,
                        1183,
                        1184,
                        1185,
                        1186,
                        1187,
                        1188,
                        1189,
                        1190,
                        1191,
                        1192,
                        1193,
                        1194,
                        1195,
                        1196,
                        1197,
                        1198,
                        1199,
                        1200,
                        1201,
                        1202,
                        1203,
                        1204,
                        1205,
                        1206,
                        1207,
                        1208,
                        1209,
                        1210,
                        1211,
                        1212,
                        1213,
                        1214,
                        1215,
                        1216,
                        1217,
                        1218,
                        1219,
                        1220,
                        1221,
                        1222,
                        1223,
                        1224,
                        1225,
                        1226,
                        1227,
                        1228,
                        1229}"
        #POCOR-7546 ends

        #POCOR-7728 starts
        Area-Administrative-Levels:
            type: object
            properties:
                id:
                    type: integer
                    format: int11
                    example: 129
                name:
                    type: string
                    format: varchar
                    example: Country

        Area-Administrative:
            type: object
            properties:
                id:
                    type: integer
                    format: int11
                    example: 129
                name:
                    type: string
                    format: varchar
                    example: Continent
        #POCOR-7728 ends

        #POCOR-7749
        examination-detail:
            type: object
            properties:
                message:
                    type: string
                    format: varchar
                    example: "Examination found."
                data:
                    type: object
                    properties:
                        id:
                            type: integer
                            format: int11
                            example: 11
                        code:
                            type: string
                            format: varchar
                            example: TEST
                        name:
                            type: string
                            format: varchar
                            example: test school
                        description:
                            type: string
                            format: varchar
                            example: description
                        registration_start_date:
                            type: object
                            format: date
                            example: "2020-01-01"
                        registration_end_date:
                            type: object
                            format: date
                            example: "2020-01-01"
                        academic_period_id:
                            type: integer
                            format: int
                            example: 29
                        education_grade_id:
                            type: integer
                            format: int
                            example: 79
                        modified_user_id:
                            type: integer
                            format: int
                            example: 2
                        modified:
                            type: object
                            format: timestamp
                            example: "2023-01-01 12:00:00"
                        created_user_id:
                            type: integer
                            format: int
                            example: 2
                        created:
                            type: object
                            format: timestamp
                            example: "2023-01-01 12:00:00"

        centre-examination:
            type: object
            properties:
                message:
                    type: string
                    format: varchar
                    example: "Successful"
                data:
                    type: object
                    properties:
                        id:
                            type: integer
                            format: int
                            example: 11
                        name:
                            type: string
                            format: varchar
                            example: test
                        code:
                            type: string
                            format: varchar
                            example: TEST
                        address:
                            type: string
                            format: text
                            example: test address
                        postal_code:
                            type: string
                            format: varchar
                            example: 8564458
                        contact_person:
                            type: string
                            format: varchar
                            example: test person
                        telephone:
                            type: string
                            format: varchar
                            example: "812-534-1001"
                        fax:
                            type: string
                            format: varchar
                            example: "83948723"
                        email:
                            type: string
                            format: varchar
                            example: "example@example.com"
                        website:
                            type: string
                            format: varchar
                            example: "www.example.com"
                        institution_id:
                            type: integer
                            format: int
                            example: 6
                        area_id:
                            type: integer
                            format: int
                            example: 21
                        academic_period_id:
                            type: integer
                            format: int
                            example: 29
                        examination_id:
                            type: integer
                            format: int
                            example: 2
                        total_registered:
                            type: integer
                            format: int
                            example: 79
                        modified_user_id:
                            type: integer
                            format: int
                            example: 2
                        modified:
                            type: object
                            format: timestamp
                            example: "2023-01-01 12:00:00"
                        created_user_id:
                            type: integer
                            format: int
                            example: 2
                        created:
                            type: object
                            format: timestamp
                            example: "2023-01-01 12:00:00"

        centre-examination-student:
            type: object
            properties:
                message:
                    type: string
                    format: varchar
                    example: "Student found."
                data:
                    type: array
                    items:
                        type: object
                        properties:
                            id:
                                type: integer
                                format: int
                                example: 11
                            marks:
                                type: number
                                format: decimal
                                example: 22.00
                            examination_subject_id:
                                type: integer
                                format: int
                                example: 34
                            student_id:
                                type: integer
                                format: int
                                example: 3340
                            academic_period_id:
                                type: integer
                                format: int
                                example: 29
                            examination_id:
                                type: integer
                                format: int
                                example: 354
                            examination_centre_id:
                                type: integer
                                format: int
                                example: 29
                            education_subject_id:
                                type: integer
                                format: int
                                example: 351
                            examination_grading_option_id:
                                type: integer
                                format: int
                                example: 58
                            institution_id:
                                type: integer
                                format: int
                                example: 79
                            modified_user_id:
                                type: integer
                                format: int
                                example: 2
                            modified:
                                type: object
                                format: timestamp
                                example: "2023-01-01 12:00:00"
                            created_user_id:
                                type: integer
                                format: int
                                example: 2
                            created:
                                type: object
                                format: timestamp
                                example: "2023-01-01 12:00:00"
        #POCOR 7749 ends

        #POCOR 7968 start
        Assessment-Period:
            type: object
            properties:
                message:
                    type: string
                    format: varchar
                    example: "Assessments data found."
                data:
                    type: array
                    items:
                        type: object
                        properties:
                            id:
                                type: string
                                format: string
                                example: "Term 1"
                            name:
                                type: string
                                format: string
                                example: "Term 1"

        Assessment-Data:
            type: object
            properties:
                message:
                    type: string
                    format: varchar
                    example: "Assessments data found."
                data:
                    type: array
                    items:
                        type: object
                        properties:
                            id:
                                type: integer
                                format: int
                                example: 32
                            code:
                                type: string
                                format: string
                                example: "Assessment"
                            name:
                                type: string
                                format: string
                                example: "Primary 1"
                            code_name:
                                type: string
                                format: string
                                example: "Assessment - Primary 1"
                            description:
                                type: string
                                format: string
                                example: ""
                            excel_template_name:
                                type: string
                                format: string
                                example: "assessment_report_template (34).xlsx"
                            assessment_type:
                                type: integer
                                format: int
                                example: 2
                            academic_period_id:
                                type: integer
                                format: int
                                example: 32
                            education_grade_id:
                                type: integer
                                format: int
                                example: 189
                            assessment_grading_type_id:
                                type: integer
                                format: int
                                example: null
                            modified_user_id:
                                type: string
                                format: string
                                example: "2023-01-13 09:33:35"
                            created_user_id:
                                type: integer
                                format: int
                                example: 2
                            created:
                                type: string
                                format: string
                                example: "2023-01-13 09:33:35"

        Assessment-Item:
            type: object
            properties:
                message:
                    type: string
                    format: varchar
                    example: "Assessments item list found."
                data:
                    type: array
                    items:
                        type: object
                        properties:
                            id:
                                type: string
                                format: string
                                example: "03d722c2-7c87-491d-9165-ace1c73abe7f"
                            weight:
                                type: integer
                                format: int
                                example: 3.5
                            classification:
                                type: string
                                format: string
                                example: ""
                            InstitutionSubjects:
                                type: string
                                format: string
                                example: "{education_subject_id: 60, id: 4516, name: Social Studies}"
                            education_subject:
                                type: string
                                format: string
                                example: "{id: 60, code_name: SSMC - Social Studies}"
                            is_editable:
                                type: integer
                                format: int
                                example: 0

        Institutions-Subject-Student:
            type: object
            properties:
                message:
                    type: string
                    format: varchar
                    example: "Institutions subject student list found."
                data:
                    type: array
                    items:
                        type: object
                        properties:
                            total_mark:
                                type: integer
                                format: int
                                example: "42.80"
                            academic_period_id:
                                type: integer
                                format: int
                                example: 32
                            education_grade_id:
                                type: integer
                                format: int
                                example: 189
                            education_subject_id:
                                type: integer
                                format: int
                                example: 60
                            student_status_id:
                                type: integer
                                format: int
                                example: 1
                            assessment_id:
                                type: integer
                                format: int
                                example: 32
                            assessment_period_id:
                                type: integer
                                format: int
                                example: 33
                            student_status_name:
                                type: string
                                format: string
                                example: "Enrolled"
                            the_student_status:
                                type: string
                                format: string
                                example: "Enrolled"
                            student_status_code:
                                type: string
                                format: string
                                example: "CURRENT"
                            student_id:
                                type: integer
                                format: integer
                                example: 27
                            first_name:
                                type: string
                                format: string
                                example: "Todd"
                            middle_name:
                                type: string
                                format: string
                                example: null
                            third_name:
                                type: string
                                format: string
                                example: null
                            last_name:
                                type: string
                                format: string
                                example: "Renner"
                            preferred_name:
                                type: string
                                format: string
                                example: null
                            the_student_code:
                                type: string
                                format: string
                                example: "1522271989"
        #POCOR 7968 end

        #POCOR 8002 start
        User-Name-List:
            type: object
            properties:
                message:
                    type: string
                    format: varchar
                    example: "User list found."
                data:
                    type: array
                    items:
                        type: object
                        properties:
                            key:
                                type: integer
                                format: int
                                example: 3
                            value:
                                type: integer
                                format: int
                                example: 1522271965
        #POCOR 8002 end

        #POCOR-7865

        time-table-detail:
            type: object
            properties:
                message:
                    type: string
                    example: "Time table data"
                data:
                    type: object
                    properties:
                        id:
                            type: integer
                        name:
                            type: string
                        status:
                            type: integer
                        academic_period_id:
                            type: integer
                        institution_class_id:
                            type: integer
                        institution_id:
                            type: integer
                        institution_schedule_interval_id:
                            type: integer
                        institution_schedule_term_id:
                            type: integer
                        modified_user_id:
                            type: integer
                            nullable: true
                        modified:
                            type: string
                            format: date-time
                            nullable: true
                        created_user_id:
                            type: integer
                        created:
                            type: string
                            format: date-time
                        academic_period:
                            type: object
                            properties:
                                id:
                                    type: integer
                                code:
                                    type: string
                                name:
                                    type: string
                                start_date:
                                    type: string
                                    format: date
                                start_year:
                                    type: integer
                                end_date:
                                    type: string
                                    format: date
                                end_year:
                                    type: integer
                                school_days:
                                    type: integer
                                current:
                                    type: integer
                                editable:
                                    type: integer
                                parent_id:
                                    type: integer
                                lft:
                                    type: integer
                                rght:
                                    type: integer
                                academic_period_level_id:
                                    type: integer
                                order:
                                    type: integer
                                visible:
                                    type: integer
                                modified_user_id:
                                    type: integer
                                    nullable: true
                                modified:
                                    type: string
                                    format: date-time
                                    nullable: true
                                created_user_id:
                                    type: integer
                                created:
                                    type: string
                                    format: date-time
                        schedule_term:
                            type: object
                            properties:
                                id:
                                    type: integer
                                name:
                                    type: string
                                class_number:
                                    type: integer
                                capacity:
                                    type: integer
                                total_male_students:
                                    type: integer
                                total_female_students:
                                    type: integer
                                staff_id:
                                    type: integer
                                institution_shift_id:
                                    type: integer
                                institution_id:
                                    type: integer
                                institution_unit_id:
                                    type: integer
                                    nullable: true
                                institution_course_id:
                                    type: integer
                                    nullable: true
                                academic_period_id:
                                    type: integer
                                modified_user_id:
                                    type: integer
                                    nullable: true
                                modified:
                                    type: string
                                    format: date-time
                                    nullable: true
                                created_user_id:
                                    type: integer
                                created:
                                    type: string
                                    format: date-time
                        schedule_interval:
                            type: object
                            properties:
                                id:
                                    type: integer
                                name:
                                    type: string
                                academic_period_id:
                                    type: integer
                                institution_id:
                                    type: integer
                                institution_shift_id:
                                    type: integer
                                modified_user_id:
                                    type: integer
                                    nullable: true
                                modified:
                                    type: string
                                    format: date-time
                                    nullable: true
                                created_user_id:
                                    type: integer
                                created:
                                    type: string
                                    format: date-time
                        institution_class:
                            type: object
                            properties:
                                id:
                                    type: integer
                                name:
                                    type: string
                                class_number:
                                    type: integer
                                capacity:
                                    type: integer
                                total_male_students:
                                    type: integer
                                total_female_students:
                                    type: integer
                                staff_id:
                                    type: integer
                                institution_shift_id:
                                    type: integer
                                institution_id:
                                    type: integer
                                institution_unit_id:
                                    type: integer
                                    nullable: true
                                institution_course_id:
                                    type: integer
                                    nullable: true
                                academic_period_id:
                                    type: integer
                                modified_user_id:
                                    type: integer
                                modified:
                                    type: string
                                    format: date-time
                                created_user_id:
                                    type: integer
                                created:
                                    type: string
                                    format: date-time

        time-table-lesson-detail:
            type: object
            properties:
                message:
                    type: string
                    example: "Time table lessons list"
                data:
                    type: array
                    items:
                        type: object
                        properties:
                            id:
                                type: integer
                            day_of_week:
                                type: integer
                            institution_schedule_timeslot_id:
                                type: integer
                            institution_schedule_timetable_id:
                                type: integer
                            modified_user_id:
                                type: integer
                                nullable: true
                            modified:
                                type: string
                                format: date-time
                                nullable: true
                            created_user_id:
                                type: integer
                            created:
                                type: string
                                format: date-time
                            schedule_lesson_details:
                                type: array
                                items:
                                    type: object
                                    properties:
                                        id:
                                            type: integer
                                        lesson_type:
                                            type: integer
                                        day_of_week:
                                            type: integer
                                        institution_schedule_timeslot_id:
                                            type: integer
                                        institution_schedule_timetable_id:
                                            type: integer
                                        modified_user_id:
                                            type: integer
                                            nullable: true
                                        modified:
                                            type: string
                                            format: date-time
                                            nullable: true
                                        created_user_id:
                                            type: integer
                                        created:
                                            type: string
                                            format: date-time
                                example:
                                    - id: 90
                                      lesson_type: 1
                                      day_of_week: 1
                                      institution_schedule_timeslot_id: 31
                                      institution_schedule_timetable_id: 3
                                      modified_user_id: null
                                      modified: null
                                      created_user_id: 573
                                      created: "2023-12-21T10:33:43"
                                    - id: 91
                                      lesson_type: 1
                                      day_of_week: 1
                                      institution_schedule_timeslot_id: 31
                                      institution_schedule_timetable_id: 3
                                      modified_user_id: null
                                      modified: null
                                      created_user_id: 573
                                      created: "2023-12-21T10:35:00"
                            timeslots:
                                type: object
                                properties:
                                    id:
                                        type: integer
                                    interval:
                                        type: integer
                                    order:
                                        type: integer
                                    institution_schedule_interval_id:
                                        type: integer
                                    start_time:
                                        type: string
                                        format: time
                                    end_time:
                                        type: string
                                        format: time
                                example:
                                    id: 31
                                    interval: 60
                                    order: 1
                                    institution_schedule_interval_id: 5
                                    start_time: "11:00:00"
                                    end_time: "12:00:00"

        lesson-type:
            type: object
            properties:
                message:
                    type: string
                    example: "Time table lessons type list"
                data:
                    type: array
                    items:
                        type: object
                        properties:
                            id:
                                type: integer
                            name:
                                type: string
                            title:
                                type: string
                                nullable: true
                    example:
                        - id: 0
                          name: "-- Select --"
                        - id: 2
                          name: "Non Curriculum Lesson"
                          title: "Non Curriculum"
                        - id: 1
                          name: "Curriculum Lesson"
                          title: "Curriculum"

        time-table-status-list:
            type: object
            properties:
                message:
                    type: string
                    example: "Time table status list"
                data:
                    type: array
                    items:
                        type: object
                        properties:
                            id:
                                type: integer
                            name:
                                type: string
                    example:
                        - id: 1
                          name: "Draft"
                        - id: 2
                          name: "Published"

        working-days-of-week:
            type: object
            properties:
                message:
                    type: string
                    example: "Working day of weeks"
                data:
                    type: array
                    items:
                        type: object
                        properties:
                            day_of_week:
                                type: integer
                            day:
                                type: string
                    example:
                        - day_of_week: 1
                          day: "Monday"
                        - day_of_week: 2
                          day: "Tuesday"
                        - day_of_week: 3
                          day: "Wednesday"
                        - day_of_week: 4
                          day: "Thursday"
                        - day_of_week: 5
                          day: "Friday"

        time-slots-detail:
            type: object
            properties:
                message:
                    type: string
                    example: "Time slots list"
                data:
                    type: array
                    items:
                        type: object
                        properties:
                            id:
                                type: integer
                            institution_schedule_interval_id:
                                type: integer
                            interval:
                                type: integer
                            order:
                                type: integer
                            start_time:
                                type: string
                                format: time
                            end_time:
                                type: string
                                format: time
                    example:
                        - id: 31
                          institution_schedule_interval_id: 5
                          interval: 60
                          order: 1
                          start_time: "11:00:00"
                          end_time: "12:00:00"
                        - id: 32
                          institution_schedule_interval_id: 5
                          interval: 70
                          order: 2
                          start_time: "11:00:00"
                          end_time: "12:10:00"

        institution-class-grade-list:
            type: object
            properties:
                message:
                    type: string
                    example: "Institution Class grades"
                data:
                    type: array
                    items:
                        type: object
                        properties:
                            id:
                                type: integer
                                example: 6
                                description: "Unique identifier for the institution class grade."
                            institution_class_id:
                                type: integer
                                example: 568
                                description: "Identifier for the institution class."
                            education_grade_id:
                                type: integer
                                example: 189
                                description: "Identifier for the education grade."
                            modified_user_id:
                                type: integer
                                nullable: true
                                description: "User ID who last modified the institution class grade."
                            modified:
                                type: string
                                format: date-time
                                nullable: true
                                description: "Timestamp of the last modification."
                            created_user_id:
                                type: integer
                                example: 2
                                description: "User ID who created the institution class grade."
                            created:
                                type: string
                                format: date-time
                                example: "2023-01-03 16:08:38"
                                description: "Timestamp of the creation of the institution class grade."
                            education_grades:
                                type: object
                                properties:
                                    id:
                                        type: integer
                                        example: 189
                                        description: "Unique identifier for the education grade."
                                    code:
                                        type: string
                                        example: "Primary 1"
                                        description: "Code for the education grade."
                                    name:
                                        type: string
                                        example: "Primary 1"
                                        description: "Name of the education grade."
                                    admission_age:
                                        type: integer
                                        example: 7
                                        description: "Admission age for the education grade."
                                    order:
                                        type: integer
                                        example: 1
                                        description: "Order of the education grade."
                                    visible:
                                        type: integer
                                        example: 1
                                        description: "Visibility status of the education grade."
                                    education_stage_id:
                                        type: integer
                                        example: 1
                                        description: "Identifier for the education stage."
                                    education_programme_id:
                                        type: integer
                                        example: 57
                                        description: "Identifier for the education programme."
                                    modified_user_id:
                                        type: integer
                                        nullable: true
                                        description: "User ID who last modified the education grade."
                                    modified:
                                        type: string
                                        format: date-time
                                        nullable: true
                                        example: "2023-01-03 16:05:56"
                                        description: "Timestamp of the last modification."
                                    created_user_id:
                                        type: integer
                                        example: 2
                                        description: "User ID who created the education grade."
                                    created:
                                        type: string
                                        format: date-time
                                        example: "2023-01-03 16:05:56"
                                        description: "Timestamp of the creation of the education grade."

        institution-room-list:
            type: object
            properties:
                message:
                    type: string
                    example: "Institution rooms."
                data:
                    type: array
                    items:
                        type: object
                        properties:
                            id:
                                type: integer
                                example: 656
                                description: "Unique identifier for the institution room."
                            code:
                                type: string
                                example: "P1002-01010101"
                                description: "Code for the institution room."
                            name:
                                type: string
                                example: "Room A1-01"
                                description: "Name of the institution room."
                            start_date:
                                type: string
                                format: date
                                example: "2023-01-01"
                                description: "Start date of the institution room."
                            start_year:
                                type: integer
                                example: 2023
                                description: "Start year of the institution room."
                            end_date:
                                type: string
                                format: date
                                example: "2023-12-31"
                                description: "End date of the institution room."
                            end_year:
                                type: integer
                                example: 2023
                                description: "End year of the institution room."
                            accessibility:
                                type: integer
                                example: 1
                                description: "Accessibility status of the institution room."
                            comment:
                                type: string
                                description: "Additional comments about the institution room."
                            room_type_id:
                                type: integer
                                example: 1
                                description: "Identifier for the room type."
                            room_status_id:
                                type: integer
                                example: 1
                                description: "Identifier for the room status."
                            institution_floor_id:
                                type: integer
                                example: 243
                                description: "Identifier for the institution floor."
                            institution_id:
                                type: integer
                                example: 6
                                description: "Identifier for the institution."
                            academic_period_id:
                                type: integer
                                example: 32
                                description: "Identifier for the academic period."
                            infrastructure_condition_id:
                                type: integer
                                example: 1
                                description: "Identifier for the infrastructure condition."
                            area:
                                type: number
                                nullable: true
                                description: "Area of the institution room."
                            previous_institution_room_id:
                                type: integer
                                example: 516
                                description: "Identifier for the previous version of the institution room."
                            modified_user_id:
                                type: integer
                                nullable: true
                                description: "User ID who last modified the institution room."
                            modified:
                                type: string
                                format: date-time
                                nullable: true
                                description: "Timestamp of the last modification."
                            created_user_id:
                                type: integer
                                example: 2
                                description: "User ID who created the institution room."
                            created:
                                type: string
                                format: date-time
                                example: "2020-03-06 05:15:01"
                                description: "Timestamp of the creation of the institution room."

        institution-class-subject-list:
            type: object
            properties:
                message:
                    type: string
                    example: "Institution Subjects."
                data:
                    type: array
                    items:
                        type: object
                        properties:
                            id:
                                type: integer
                                example: 50
                                description: "Unique identifier for the institution subject."
                            status:
                                type: integer
                                example: 1
                                description: "Status of the institution subject."
                            institution_class_id:
                                type: integer
                                example: 568
                                description: "Identifier for the institution class."
                            institution_subject_id:
                                type: integer
                                example: 4523
                                description: "Identifier for the institution subject."
                            modified_user_id:
                                type: integer
                                nullable: true
                                description: "User ID who last modified the institution subject."
                            modified:
                                type: string
                                format: date-time
                                nullable: true
                                description: "Timestamp of the last modification."
                            created_user_id:
                                type: integer
                                example: 2
                                description: "User ID who created the institution subject."
                            created:
                                type: string
                                format: date-time
                                example: "2023-01-03 16:08:38"
                                description: "Timestamp of the creation of the institution subject."
                            institution_subject:
                                type: object
                                properties:
                                    id:
                                        type: integer
                                        example: 4523
                                        description: "Unique identifier for the institution subject."
                                    name:
                                        type: string
                                        example: "Science"
                                        description: "Name of the institution subject."
                                    no_of_seats:
                                        type: integer
                                        nullable: true
                                        description: "Number of seats for the subject."
                                    total_male_students:
                                        type: integer
                                        example: 13
                                        description: "Total male students for the subject."
                                    total_female_students:
                                        type: integer
                                        example: 7
                                        description: "Total female students for the subject."
                                    institution_id:
                                        type: integer
                                        example: 6
                                        description: "Identifier for the institution."
                                    education_grade_id:
                                        type: integer
                                        example: 189
                                        description: "Identifier for the education grade."
                                    education_subject_id:
                                        type: integer
                                        example: 97
                                        description: "Identifier for the education subject."
                                    academic_period_id:
                                        type: integer
                                        example: 32
                                        description: "Identifier for the academic period."
                                    modified_user_id:
                                        type: integer
                                        nullable: true
                                        description: "User ID who last modified the institution subject."
                                    modified:
                                        type: string
                                        format: date-time
                                        nullable: true
                                        description: "Timestamp of the last modification."
                                    created_user_id:
                                        type: integer
                                        example: 2
                                        description: "User ID who created the institution subject."
                                    created:
                                        type: string
                                        format: date-time
                                        example: "2023-01-03 16:08:38"
                                        description: "Timestamp of the creation of the institution subject."

        delete-lesson:
            type: object
            properties:
                message:
                    type: string
                    description: A success message
                data:
                    type: array
                    items: {}
                    description: An array representing the deleted lesson data
            example:
                message: Lesson Id deleted successfully
                data: []

        add-lesson:
            type: object
            properties:
                message:
                    type: string
                    description: A success message
                data:
                    type: array
                    items: {}
                    description: An array representing the deleted lesson data
            example:
                message: Lesson successfully added
                data: []

        #POCOR 7865 end

        #POCOR 7856 start

        Report-Card-Subject-Comment:
            type: object
            properties:
                message:
                    type: string
                    description: Report Card Student List Found
                data:
                    type: array
                    items:
                        type: object
                        properties:
                            student_id:
                                type: integer
                                example: 1311
                            student_user_id:
                                type: integer
                                example: 1311
                            student_openemis_no:
                                type: integer
                                example: 1522413076
                            student_gender:
                                type: string
                                example: ""
                            comments:
                                type: string
                                example: "He faithfully performs classroom tasks."
                            comments_code:
                                type: integer
                                example: 1
                            student_status:
                                type: object
                                properties:
                                    id:
                                        type: integer
                                        example: 7
                                    code:
                                        type: string
                                        example: "PROMOTED"
                                    name:
                                        type: string
                                        example: "Promoted"
                            student_status_name:
                                type: string
                                example: "Promoted"
                            InstitutionStudentsReportCards:
                                type: object
                                properties:
                                    report_card_id:
                                        type: integer
                                        example: 7
                            Staff:
                                type: object
                                properties:
                                    first_name:
                                        type: string
                                        example: "System"
                                    last_name:
                                        type: string
                                        example: "Admin"
                            reportCardStartDate:
                                type: string
                                example: "2018-01-01"
                            reportCardEndDate:
                                type: string
                                example: "2018-12-31"
                            total_mark:
                                type: integer
                                example: 175
                            _matchingData:
                                type: object
                                properties:
                                    Users:
                                        type: object
                                        properties:
                                            id:
                                                type: integer
                                                example: 8842
                                            first_name:
                                                type: string
                                                example: "Bastien"
                                            middle_name:
                                                type: string
                                                example: ""
                                            third_name:
                                                type: string
                                                example: ""
                                            last_name:
                                                type: string
                                                example: "Danby"
                                            openemis_no:
                                                type: integer
                                                example: 1524270931
                                            preferred_name:
                                                type: string
                                                example: ""
                                            full_name:
                                                type: string
                                                example: "Bastien  Danby"
                                            name_with_id:
                                                type: string
                                                example: "1524270931 - Bastien  Danby"

        Report-Card-Subject:
            type: object
            properties:
                message:
                    type: string
                    description: Report Card Student List Found
                data:
                    type: array
                    items:
                        type: object
                        properties:
                            education_subject_id:
                                type: integer
                                example: 1
                            education_subject_code:
                                type: string
                                example: "LAC"
                            institution_subjects_name:
                                type: string
                                example: "Language Arts Content Standards and Learning Outcomes"
                            institution_subjects_id:
                                type: integer
                                example: 1
                            order:
                                type: integer
                                example: 1
                            staff_id:
                                type: integer
                                example: 573

        #POCOR 7856 end

        #POCOR-8025 start
        Nationalities-List:
            type: object
            properties:
                message:
                    type: string
                    format: varchar
                    example: "Nationality list found."
                data:
                    type: array
                    items:
                        type: object
                        properties:
                            id:
                                type: integer
                                format: int
                                example: 5
                            name:
                                type: string
                                format: string
                                example: "Algerian"
                            is_refugee:
                                type: integer
                                format: int
                                example: 0
                            national_code:
                                type: string
                                format: string
                                example: ""
                            international_code:
                                type: string
                                format: string
                                example: ""
                            modified_user_id:
                                type: integer
                                format: int
                                example: 2
                            modified:
                                type: string
                                format: string
                                example: "2018-04-19 08:03:39"
                            created_user_id:
                                type: integer
                                format: int
                                example: 2
                            created:
                                type: string
                                format: string
                                example: "2018-04-19 06:03:39"

        Identities-Type:
            type: object
            properties:
                message:
                    type: string
                    format: varchar
                    example: "Identity types list found."
                data:
                    type: array
                    items:
                        type: object
                        properties:
                            id:
                                type: integer
                                format: int
                                example: 161
                            name:
                                type: string
                                format: string
                                example: "Passport"
        #POCOR-8025 end

        #POCOR-8069 start
        Institution-Types-List:
            type: object
            properties:
                message:
                    type: string
                    format: varchar
                    example: "Institution types list found."
                data:
                    type: array
                    items:
                        type: object
                        properties:
                            id:
                                type: integer
                                format: int
                                example: 1
                            name:
                                type: string
                                format: string
                                example: "Pre-primary"
        #POCOR-8069 end

        #POCOR-7946 start
        Attendance-Mark-Types-Education-Grades:
            type: object
            properties:
                message:
                    type: string
                    format: varchar
                    example: "Education Grade List Found."
                data:
                    type: array
                    items:
                        type: object
                        properties:
                            academic_period_name:
                                type: integer
                                format: int
                                example: 2023
                            academic_period_id:
                                type: integer
                                format: int
                                example: 32
                            education_grade_name:
                                type: string
                                format: string
                                example: "Primary 1"
                            education_grade_id:
                                type: integer
                                format: int
                                example: 189
                            attendance_per_day:
                                type: integer
                                format: int
                                example: 2
                            attendance_by:
                                type: string
                                format: string
                                example: "DAY"
                            period_name:
                                type: string
                                format: string
                                example: "Period 1"
                            date_enabled:
                                type: string
                                format: string
                                example: "2023-01-01"
                            date_disabled:
                                type: string
                                format: string
                                example: "2023-12-31"
                            value:
                                type: integer
                                format: int
                                example: 1
                            day_configuration:
                                type: string
                                format: string
                                example: "Mark absent if one or more records absent"

        Institution-Class-Subjects:
            type: object
            properties:
                message:
                    type: string
                    format: varchar
                    example: "Institution Class Subjects Found."
                data:
                    type: array
                    items:
                        type: object
                        properties:
                            academic_period_id:
                                type: integer
                                format: int
                                example: 32
                            institution_id:
                                type: integer
                                format: int
                                example: 6
                            institution_class_id:
                                type: integer
                                format: int
                                example: 9
                            institution_class_name:
                                type: string
                                format: string
                                example: "Primary 1-A"
                            institution_subject_id:
                                type: integer
                                format: int
                                example: 40
                            institution_subject_name:
                                type: string
                                format: string
                                example: "Science"
                            education_subject_id:
                                type: integer
                                format: int
                                example: 97
                            education_grade_id:
                                type: integer
                                format: int
                                example: 59
                            total_male_students:
                                type: integer
                                format: int
                                example: 31
                            total_female_students:
                                type: integer
                                format: int
                                example: 19
                            modified_user_id:
                                type: integer
                                format: int
                                example: 2
                            modified:
                                type: string
                                format: string
                                example: "2018-03-30 23:48:00"
                            created_user_id:
                                type: integer
                                format: int
                                example: 2
                            created:
                                type: string
                                format: string
                                example: "2018-03-30 23:48:00"
        #POCOR-7946 end

        #POCOR-7855 starts
        student-meal:
            type: object
            properties:
                message:
                    type: string
                    format: varchar
                    example: "Institution Student Meals List found."
                data:
                    type: array
                    items:
                        type: object
                        properties:
                            institution_id:
                                type: integer
                                format: int
                                example: 79
                            institution_class_id:
                                type: integer
                                format: int
                                example: 79
                            academic_period_id:
                                type: integer
                                format: int
                                example: 29
                            date:
                                type: string
                                format: varchar
                                example: "2023-09-09"
                            meal_programmes_id:
                                type: integer
                                format: int
                                example: 29
                            meal_received_id:
                                type: integer
                                format: int
                                example: 1
                            meal_benefit_id:
                                type: integer
                                format: int
                                example: 1

        meal-benefits:
            type: object
            properties:
                message:
                    type: string
                    format: varchar
                    example: "Meal benefit is created/updated successfully."
                data:
                    type: array
                    items:
                        type: object
                        properties:
                            id:
                                type: integer
                                format: int
                                example: 1
                            name:
                                type: string
                                format: string
                                example: "100%"
                            order:
                                type: integer
                                format: int
                                example: 1
                            visible:
                                type: integer
                                format: int
                                example: 1
                            default:
                                type: integer
                                format: int
                                example: 1
                            international_code:
                                type: string
                                format: string
                                example: ""
                            national_code:
                                type: string
                                format: string
                                example: ""
                            modified_user_id:
                                type: integer
                                format: int
                                example: Null
                            modified:
                                type: string
                                format: string
                                example: Null
                            created_user_id:
                                type: integer
                                format: int
                                example: 1
                            created:
                                type: string
                                format: string
                                example: "2021-03-19 07:57:55"

        institution-student-meal:
            type: object
            properties:
                message:
                    type: string
                    format: varchar
                    example: "Student Meals List By Intitution Id Found."
                data:
                    type: array
                    items:
                        type: object
                        properties:
                            institution_id:
                                type: integer
                                format: int
                                example: 79
                            institution_class_id:
                                type: integer
                                format: int
                                example: 79
                            academic_period_id:
                                type: integer
                                format: int
                                example: 29
                            date:
                                type: string
                                format: varchar
                                example: "2023-09-09"
                            meal_programmes_id:
                                type: integer
                                format: int
                                example: 29
                            meal_received_id:
                                type: integer
                                format: int
                                example: 1
                            meal_benefit_id:
                                type: integer
                                format: int
                                example: 1

        meal-programmes:
            type: object
            properties:
                message:
                    type: string
                    format: varchar
                    example: "Meal Programmes list found."
                data:
                    type: array
                    items:
                        type: object
                        properties:
                            id:
                                type: integer
                                format: int
                                example: 1
                            academic_period_id:
                                type: integer
                                format: int
                                example: 30
                            name:
                                type: string
                                format: string
                                example: "National Meal Programme"
                            code:
                                type: string
                                format: string
                                example: "NMP"
                            type:
                                type: integer
                                format: int
                                example: 1
                            targeting:
                                type: integer
                                format: int
                                example: 1
                            start_date:
                                type: string
                                format: string
                                example: "2021-01-01"
                            end_date:
                                type: string
                                format: string
                                example: "2021-12-31"
                            amount:
                                type: integer
                                format: int
                                example: 10.00
                            implementer:
                                type: integer
                                format: int
                                example: 1
                            modified_user_id:
                                type: integer
                                format: int
                                example: Null
                            modified:
                                type: string
                                format: string
                                example: Null
                            created_user_id:
                                type: integer
                                format: int
                                example: 2
                            created:
                                type: string
                                format: string
                                example: "2021-03-22 08:43:37"
        #POCOR-7855 ends

        #POCOR-8125/7854 starts

        Institution-Class-Grades:
            type: object
            properties:
                message:
                    type: string
                    format: varchar
                    example: "Institution Class grades list found."
                data:
                    type: array
                    items:
                        type: object
                        properties:
                            id:
                                type: string
                                format: string
                                example: "81b456c6-f742-4ba2-a1e3-dee072a4cf4a"
                            institution_class_id:
                                type: integer
                                format: int
                                example: 591
                            education_grade_id:
                                type: integer
                                format: int
                                example: 206
                            modified_user_id:
                                type: integer
                                format: int
                                example: Null
                            modified:
                                type: string
                                format: string
                                example: Null
                            created_user_id:
                                type: integer
                                format: int
                                example: 2
                            created:
                                type: string
                                format: string
                                example: "2023-12-05 11:29:36"
                            education_grades:
                                type: object
                                properties:
                                    id:
                                        type: integer
                                        example: 206
                                    code:
                                        type: string
                                        example: "Primary 1"
                                    name:
                                        type: string
                                        example: "Primary 1"
                                    admission_age:
                                        type: integer
                                        example: 7
                                    order:
                                        type: integer
                                        example: 1
                                    visible:
                                        type: integer
                                        example: 1
                                    education_stage_id:
                                        type: integer
                                        example: 1
                                    education_programme_id:
                                        type: integer
                                        example: 63
                                    modified_user_id:
                                        type: integer
                                        example: Null
                                    modified:
                                        type: string
                                        example: Null
                                    created_user_id:
                                        type: integer
                                        example: 2
                                    created:
                                        type: string
                                        example: "2023-12-05 11:29:36"

        Grade-Attendance-Types:
            type: object
            properties:
                message:
                    type: string
                    format: varchar
                    example: "Attendance Types Found."
                data:
                    type: array
                    items:
                        type: object
                        properties:
                            id:
                                type: integer
                                format: int
                                example: 1
                            code:
                                type: string
                                format: string
                                example: "SUBJECT"

        Institution-Grade-Class-Subject:
            type: object
            properties:
                message:
                    type: string
                    format: varchar
                    example: "Subjects List Found."
                data:
                    type: array
                    items:
                        type: object
                        properties:
                            id:
                                type: integer
                                format: int
                                example: 4720
                            name:
                                type: string
                                format: string
                                example: "Spanish"

        Student-Attendance-Mark:
            type: object
            properties:
                message:
                    type: string
                    format: varchar
                    example: "Student Attendance Mark Type Found."
                data:
                    type: array
                    items:
                        type: object
                        properties:
                            id:
                                type: integer
                                format: int
                                example: 1
                            name:
                                type: string
                                format: string
                                example: "Period 1"

        Student-Attendances:
            type: object
            properties:
                message:
                    type: string
                    format: varchar
                    example: "Student Attendance List Found."
                data:
                    type: array
                    items:
                        type: object
                        properties:
                            academic_period_id:
                                type: integer
                                format: int
                                example: 33
                            institution_class_id:
                                type: integer
                                format: int
                                example: 591
                            institution_id:
                                type: integer
                                format: int
                                example: 6
                            student_id:
                                type: integer
                                format: int
                                example: 13674
                            user:
                                type: object
                                properties:
                                    id:
                                        type: integer
                                        example: 13674
                                    username:
                                        type: integer
                                        example: 2382817290
                                    openemis_no:
                                        type: integer
                                        example: 2382817290
                                    first_name:
                                        type: string
                                        example: "Candie"
                                    middle_name:
                                        type: string
                                        example: Null
                                    third_name:
                                        type: string
                                        example: Null
                                    last_name:
                                        type: string
                                        example: "Reagan"
                                    preferred_name:
                                        type: string
                                        example: Null
                            institution_student_absences:
                                type: object
                                properties:
                                    date:
                                        type: string
                                        example: "2024-02-05"
                                    period:
                                        type: integer
                                        example: 1
                                    comment:
                                        type: string
                                        example: Null
                                    absence_type_id:
                                        type: integer
                                        example: 3
                                    student_absence_reason_id:
                                        type: integer
                                        example: Null
                                    absence_type_code:
                                        type: string
                                        example: "LATE"
                            is_NoClassScheduled:
                                type: integer
                                example: 0

        Student-Attendance-Marked:
            type: object
            properties:
                message:
                    type: string
                    format: varchar
                    example: "Student Attendance Marked List Found."
                data:
                    type: array
                    items:
                        type: object
                        properties:
                            institution_id:
                                type: integer
                                format: int
                                example: 6
                            academic_period_id:
                                type: integer
                                format: int
                                example: 33
                            institution_class_id:
                                type: integer
                                format: int
                                example: 591
                            education_grade_id:
                                type: integer
                                format: int
                                example: 206
                            date:
                                type: string
                                format: string
                                example: "2024-02-05"
                            period:
                                type: integer
                                format: int
                                example: 1
                            subject_id:
                                type: integer
                                format: int
                                example: 0
                            no_scheduled_class:
                                type: integer
                                format: int
                                example: 0
        Absence-Types:
            type: "object"
            properties:
                message:
                    type: string
                    format: varchar
                    example: "Absence Types List Found."
                data:
                    type: array
                    items:
                        type: object
                        properties:
                            id:
                                type: integer
                                format: int
                                example: 1
                            code:
                                type: string
                                format: string
                                example: "EXCUSED"
                            name:
                                type: string
                                format: string
                                example: "Absence - Excused"

        Absence-Reasons:
            type: "object"
            properties:
                message:
                    type: string
                    format: varchar
                    example: "Absence Reasons List Found."
                data:
                    type: array
                    items:
                        type: object
                        properties:
                            id:
                                type: integer
                                format: int
                                example: 1
                            name:
                                type: string
                                format: string
                                example: "Illness"

        #POCOR-8125/7854 ends

        #POCOR-7947 starts
        institution-students:
            type: object
            properties:
                message:
                    type: string
                    example: "Institutions Students List Found"
                data:
                    type: object
                    properties:
                        current_page:
                            type: integer
                            example: 1
                        data:
                            type: array
                            items:
                                type: object
                                properties:
                                    student_id:
                                        type: integer
                                        example: 12047
                                    first_name:
                                        type: string
                                        example: "Rheba"
                                    middle_name:
                                        type: string
                                        example: "Paulie"
                                    third_name:
                                        type: string
                                        example: "Abbie"
                                    last_name:
                                        type: string
                                        example: "MacWhirter"
                                    openemis_no:
                                        type: string
                                        example: "1611035684"
                                    date_of_birth:
                                        type: string
                                        example: "2014-02-14"
                                    date_of_death:
                                        type: string
                                        example: null
                                    identity_number:
                                        type: string
                                        example: null
                                    external_reference:
                                        type: string
                                        example: null
                                    gender_id:
                                        type: integer
                                        example: 2
                                    gender_name:
                                        type: string
                                        example: "Female"
                                    start_date:
                                        type: string
                                        example: "2023-01-01"
                                    start_year:
                                        type: integer
                                        example: 2023
                                    end_date:
                                        type: string
                                        example: "2023-12-31"
                                    end_year:
                                        type: integer
                                        example: 2023
                                    institution_id:
                                        type: integer
                                        example: 6
                                    institution_code:
                                        type: string
                                        example: "P1002"
                                    institution_name:
                                        type: string
                                        example: "Avory Primary School"
                                    student_status_id:
                                        type: integer
                                        example: 1
                                    student_status_name:
                                        type: string
                                        example: "Enrolled"
                                    student_status_code:
                                        type: string
                                        example: "CURRENT"
                                    education_grade_id:
                                        type: integer
                                        example: 190
                                    education_grade_name:
                                        type: string
                                        example: "Primary 2"
                                    academic_period_id:
                                        type: integer
                                        example: 32
                                    academic_period_name:
                                        type: string
                                        example: "2023"
                                    previous_institution_student_id:
                                        type: string
                                        example: "ccc5ff14-5be7-4ed7-8433-7961ed9e6a57"
                                    modified_user_id:
                                        type: string
                                        example: null
                                    modified:
                                        type: string
                                        example: null
                                    created_user_id:
                                        type: integer
                                        example: 2
                                    created:
                                        type: string
                                        example: "2023-01-03 16:34:25"
                        first_page_url:
                            type: string
                            example: "http://127.0.0.1:8002/v4/institutions/students?page=1"
                        from:
                            type: integer
                            example: 1
                        last_page:
                            type: integer
                            example: 45
                        last_page_url:
                            type: string
                            example: "http://127.0.0.1:8002/v4/institutions/students?page=45"
                        links:
                            type: array
                            items:
                                type: object
                                properties:
                                    url:
                                        type: string
                                        example: null
                                    label:
                                        type: string
                                        example: "&laquo; Previous"
                                    active:
                                        type: boolean
                                        example: false
                        next_page_url:
                            type: string
                            example: "http://127.0.0.1:8002/v4/institutions/students?page=2"
                        path:
                            type: string
                            example: "http://127.0.0.1:8002/v4/institutions/students"
                        per_page:
                            type: string
                            example: "5"
                        prev_page_url:
                            type: string
                            example: null
                        to:
                            type: integer
                            example: 5
                        total:
                            type: integer
                            example: 224

        institution-students-absences:
            type: object
            properties:
                message:
                    type: string
                    example: Institutions Student Absences List Found
                data:
                    type: object
                    properties:
                        current_page:
                            type: integer
                            example: 1
                        data:
                            type: array
                            items:
                                type: object
                                properties:
                                    student_id:
                                        type: integer
                                        example: 11763
                                    first_name:
                                        type: string
                                        example: Iolanthe
                                    middle_name:
                                        type: string
                                        example: null
                                    third_name:
                                        type: string
                                        example: null
                                    last_name:
                                        type: string
                                        example: Mathes
                                    openemis_no:
                                        type: string
                                        example: 1548405606
                                    date_of_birth:
                                        type: string
                                        example: 2013-11-20
                                    date_of_death:
                                        type: string
                                        example: null
                                    identity_number:
                                        type: string
                                        example: null
                                    external_reference:
                                        type: string
                                        example: null
                                    gender_id:
                                        type: integer
                                        example: 2
                                    gender_name:
                                        type: string
                                        example: Female
                                    institution_id:
                                        type: integer
                                        example: 6
                                    institution_code:
                                        type: string
                                        example: P1002
                                    institution_name:
                                        type: string
                                        example: Avory Primary School
                                    education_grade_id:
                                        type: integer
                                        example: 189
                                    education_grade_name:
                                        type: string
                                        example: Primary 1
                                    academic_period_id:
                                        type: integer
                                        example: 32
                                    academic_period_name:
                                        type: string
                                        example: 2023
                                    institution_class_id:
                                        type: integer
                                        example: 569
                                    institution_class_name:
                                        type: string
                                        example: Primary 1-B
                                    date:
                                        type: array
                                        items:
                                            type: object
                                            properties:
                                                period_id:
                                                    type: string
                                                    example: null
                                                period_name:
                                                    type: string
                                                    example: null
                                                subject_id:
                                                    type: string
                                                    example: null
                                                subject_name:
                                                    type: string
                                                    example: null
                                                absence_type_id:
                                                    type: integer
                                                    example: 1
                                                absence_type_name:
                                                    type: string
                                                    example: Absence - Excused
                                                student_absence_reason_id:
                                                    type: integer
                                                    example: 1
                                                student_absence_reason_name:
                                                    type: string
                                                    example: Illness
                                                comment:
                                                    type: string
                                                    example: null
                                                date:
                                                    type: string
                                                    example: 2023-07-10
                                    modified_user_id:
                                        type: string
                                        example: null
                                    modified:
                                        type: string
                                        example: null
                                    created_user_id:
                                        type: integer
                                        example: 2
                                    created:
                                        type: string
                                        example: 2023-07-10 02:11:44
                        first_page_url:
                            type: string
                            example: "http://127.0.0.1:8002/v4/institutions/students/absences?page=1"
                        from:
                            type: integer
                            example: 1
                        last_page:
                            type: integer
                            example: 1
                        last_page_url:
                            type: string
                            example: "http://127.0.0.1:8002/v4/institutions/students/absences?page=1"
                        links:
                            type: array
                            items:
                                type: object
                                properties:
                                    url:
                                        type: string
                                        example: null
                                    label:
                                        type: string
                                        example: "&laquo; Previous"
                                    active:
                                        type: boolean
                                        example: false
                        next_page_url:
                            type: string
                            example: null
                        path:
                            type: string
                            example: "http://127.0.0.1:8002/v4/institutions/students/absences"
                        per_page:
                            type: string
                            example: "10"
                        prev_page_url:
                            type: string
                            example: null
                        to:
                            type: integer
                            example: 1
                        total:
                            type: integer
                            example: 1
        institution-students-by-institution-id:
            type: object
            properties:
                message:
                    type: string
                    example: Institutions Students List Found
                data:
                    type: object
                    properties:
                        current_page:
                            type: integer
                            example: 1
                        data:
                            type: array
                            items:
                                type: object
                                properties:
                                    student_id:
                                        type: integer
                                        example: 12047
                                    first_name:
                                        type: string
                                        example: Rheba
                                    middle_name:
                                        type: string
                                        example: Paulie
                                    third_name:
                                        type: string
                                        example: Abbie
                                    last_name:
                                        type: string
                                        example: MacWhirter
                                    openemis_no:
                                        type: string
                                        example: "1611035684"
                                    date_of_birth:
                                        type: string
                                        example: "2014-02-14"
                                    date_of_death:
                                        type: string
                                        example: null
                                    identity_number:
                                        type: string
                                        example: null
                                    external_reference:
                                        type: string
                                        example: null
                                    gender_id:
                                        type: integer
                                        example: 2
                                    gender_name:
                                        type: string
                                        example: Female
                                    start_date:
                                        type: string
                                        example: "2023-01-01"
                                    start_year:
                                        type: integer
                                        example: 2023
                                    end_date:
                                        type: string
                                        example: "2023-12-31"
                                    end_year:
                                        type: integer
                                        example: 2023
                                    institution_id:
                                        type: integer
                                        example: 6
                                    institution_code:
                                        type: string
                                        example: P1002
                                    institution_name:
                                        type: string
                                        example: Avory Primary School
                                    student_status_id:
                                        type: integer
                                        example: 1
                                    student_status_name:
                                        type: string
                                        example: Enrolled
                                    student_status_code:
                                        type: string
                                        example: CURRENT
                                    education_grade_id:
                                        type: integer
                                        example: 190
                                    education_grade_name:
                                        type: string
                                        example: Primary 2
                                    academic_period_id:
                                        type: integer
                                        example: 32
                                    academic_period_name:
                                        type: string
                                        example: 2023
                                    previous_institution_student_id:
                                        type: string
                                        example: "ccc5ff14-5be7-4ed7-8433-7961ed9e6a57"
                                    modified_user_id:
                                        type: string
                                        example: null
                                    modified:
                                        type: string
                                        example: null
                                    created_user_id:
                                        type: integer
                                        example: 2
                                    created:
                                        type: string
                                        example: "2023-01-03 16:34:25"
                        first_page_url:
                            type: string
                            example: "http://127.0.0.1:8002/v4/institutions/6/students?page=1"
                        from:
                            type: integer
                            example: 1
                        last_page:
                            type: integer
                            example: 45
                        last_page_url:
                            type: string
                            example: "http://127.0.0.1:8002/v4/institutions/6/students?page=45"
                        links:
                            type: array
                            items:
                                type: object
                                properties:
                                    url:
                                        type: string
                                        example: null
                                    label:
                                        type: string
                                        example: "&laquo; Previous"
                                    active:
                                        type: boolean
                                        example: false
                        next_page_url:
                            type: string
                            example: "http://127.0.0.1:8002/v4/institutions/6/students?page=2"
                        path:
                            type: string
                            example: "http://127.0.0.1:8002/v4/institutions/6/students"
                        per_page:
                            type: string
                            example: "5"
                        prev_page_url:
                            type: string
                            example: null
                        to:
                            type: integer
                            example: 5
                        total:
                            type: integer
                            example: 224
        institution-student-detail:
            type: object
            properties:
                message:
                    type: string
                    example: Institutions Student Data Found
                data:
                    type: object
                    properties:
                        student_id:
                            type: integer
                            example: 12047
                        first_name:
                            type: string
                            example: Rheba
                        middle_name:
                            type: string
                            example: Paulie
                        third_name:
                            type: string
                            example: Abbie
                        last_name:
                            type: string
                            example: MacWhirter
                        openemis_no:
                            type: string
                            example: "1611035684"
                        date_of_birth:
                            type: string
                            example: "2014-02-14"
                        date_of_death:
                            type: string
                            example: null
                        identity_number:
                            type: string
                            example: null
                        external_reference:
                            type: string
                            example: null
                        gender_id:
                            type: integer
                            example: 2
                        gender_name:
                            type: string
                            example: Female
                        start_date:
                            type: string
                            example: "2023-01-01"
                        start_year:
                            type: integer
                            example: 2023
                        end_date:
                            type: string
                            example: "2023-12-31"
                        end_year:
                            type: integer
                            example: 2023
                        institution_id:
                            type: integer
                            example: 6
                        institution_code:
                            type: string
                            example: P1002
                        institution_name:
                            type: string
                            example: Avory Primary School
                        student_status_id:
                            type: integer
                            example: 1
                        student_status_name:
                            type: string
                            example: Enrolled
                        student_status_code:
                            type: string
                            example: CURRENT
                        education_grade_id:
                            type: integer
                            example: 190
                        education_grade_name:
                            type: string
                            example: Primary 2
                        academic_period_id:
                            type: integer
                            example: 32
                        academic_period_name:
                            type: string
                            example: 2023
                        previous_institution_student_id:
                            type: string
                            example: "ccc5ff14-5be7-4ed7-8433-7961ed9e6a57"
                        modified_user_id:
                            type: string
                            example: null
                        modified:
                            type: string
                            example: null
                        created_user_id:
                            type: integer
                            example: 2
                        created:
                            type: string
                            example: "2023-01-03 16:34:25"
        institution-student-absences-details:
            type: object
            properties:
                message:
                    type: string
                    example: Institutions Student Absences Data Found
                data:
                    type: object
                    properties:
                        student_id:
                            type: integer
                            example: 11763
                        first_name:
                            type: string
                            example: Iolanthe
                        middle_name:
                            type: string
                            example: null
                        third_name:
                            type: string
                            example: null
                        last_name:
                            type: string
                            example: Mathes
                        openemis_no:
                            type: string
                            example: "1548405606"
                        date_of_birth:
                            type: string
                            example: "2013-11-20"
                        date_of_death:
                            type: string
                            example: null
                        identity_number:
                            type: string
                            example: null
                        external_reference:
                            type: string
                            example: null
                        gender_id:
                            type: integer
                            example: 2
                        gender_name:
                            type: string
                            example: Female
                        institution_id:
                            type: integer
                            example: 6
                        institution_code:
                            type: string
                            example: P1002
                        institution_name:
                            type: string
                            example: Avory Primary School
                        education_grade_id:
                            type: integer
                            example: 189
                        education_grade_name:
                            type: string
                            example: Primary 1
                        academic_period_id:
                            type: integer
                            example: 32
                        academic_period_name:
                            type: string
                            example: 2023
                        institution_class_id:
                            type: integer
                            example: 569
                        institution_class_name:
                            type: string
                            example: Primary 1-B
                        date:
                            type: array
                            items:
                                type: object
                                properties:
                                    period_id:
                                        type: string
                                        example: null
                                    period_name:
                                        type: string
                                        example: null
                                    subject_id:
                                        type: string
                                        example: null
                                    subject_name:
                                        type: string
                                        example: null
                                    absence_type_id:
                                        type: integer
                                        example: 1
                                    absence_type_name:
                                        type: string
                                        example: Absence - Excused
                                    student_absence_reason_id:
                                        type: integer
                                        example: 1
                                    student_absence_reason_name:
                                        type: string
                                        example: Illness
                                    comment:
                                        type: string
                                        example: null
                                    date:
                                        type: string
                                        example: "2023-07-10"
                        modified_user_id:
                            type: string
                            example: null
                        modified:
                            type: string
                            example: null
                        created_user_id:
                            type: integer
                            example: 2
                        created:
                            type: string
                            example: "2023-07-10 02:11:44"
        institution-students-absences-institution-id:
            type: object
            properties:
                message:
                    type: string
                    example: Institutions Student Absences List Found
                data:
                    type: object
                    properties:
                        current_page:
                            type: integer
                            example: 1
                        data:
                            type: array
                            items:
                                type: object
                                properties:
                                    student_id:
                                        type: integer
                                        example: 11763
                                    first_name:
                                        type: string
                                        example: Iolanthe
                                    middle_name:
                                        type: string
                                        example: null
                                    third_name:
                                        type: string
                                        example: null
                                    last_name:
                                        type: string
                                        example: Mathes
                                    openemis_no:
                                        type: string
                                        example: 1548405606
                                    date_of_birth:
                                        type: string
                                        example: 2013-11-20
                                    date_of_death:
                                        type: string
                                        example: null
                                    identity_number:
                                        type: string
                                        example: null
                                    external_reference:
                                        type: string
                                        example: null
                                    gender_id:
                                        type: integer
                                        example: 2
                                    gender_name:
                                        type: string
                                        example: Female
                                    institution_id:
                                        type: integer
                                        example: 6
                                    institution_code:
                                        type: string
                                        example: P1002
                                    institution_name:
                                        type: string
                                        example: Avory Primary School
                                    education_grade_id:
                                        type: integer
                                        example: 189
                                    education_grade_name:
                                        type: string
                                        example: Primary 1
                                    academic_period_id:
                                        type: integer
                                        example: 32
                                    academic_period_name:
                                        type: string
                                        example: 2023
                                    institution_class_id:
                                        type: integer
                                        example: 569
                                    institution_class_name:
                                        type: string
                                        example: Primary 1-B
                                    date:
                                        type: array
                                        items:
                                            type: object
                                            properties:
                                                period_id:
                                                    type: string
                                                    example: null
                                                period_name:
                                                    type: string
                                                    example: null
                                                subject_id:
                                                    type: string
                                                    example: null
                                                subject_name:
                                                    type: string
                                                    example: null
                                                absence_type_id:
                                                    type: integer
                                                    example: 1
                                                absence_type_name:
                                                    type: string
                                                    example: Absence - Excused
                                                student_absence_reason_id:
                                                    type: integer
                                                    example: 1
                                                student_absence_reason_name:
                                                    type: string
                                                    example: Illness
                                                comment:
                                                    type: string
                                                    example: null
                                                date:
                                                    type: string
                                                    example: 2023-07-10
                                    modified_user_id:
                                        type: string
                                        example: null
                                    modified:
                                        type: string
                                        example: null
                                    created_user_id:
                                        type: integer
                                        example: 2
                                    created:
                                        type: string
                                        example: 2023-07-10 02:11:44
                        first_page_url:
                            type: string
                            example: "http://127.0.0.1:8002/v4/institutions/6/students/absences?page=1"
                        from:
                            type: integer
                            example: 1
                        last_page:
                            type: integer
                            example: 1
                        last_page_url:
                            type: string
                            example: "http://127.0.0.1:8002/v4/institutions/6/students/absences?page=1"
                        links:
                            type: array
                            items:
                                type: object
                                properties:
                                    url:
                                        type: string
                                        example: null
                                    label:
                                        type: string
                                        example: "&laquo; Previous"
                                    active:
                                        type: boolean
                                        example: false
                        next_page_url:
                            type: string
                            example: null
                        path:
                            type: string
                            example: "http://127.0.0.1:8002/v4/institutions/6/students/absences"
                        per_page:
                            type: string
                            example: "10"
                        prev_page_url:
                            type: string
                            example: null
                        to:
                            type: integer
                            example: 1
                        total:
                            type: integer
                            example: 1

        #POCOR-7947 ends

        #POCOR-8104 Starts

        User-Types:
            type: "object"
            properties:
                message:
                    type: string
                    format: varchar
                    example: "User Types List Found."
                data:
                    type: array
                    items:
                        type: object
                        properties:
                            id:
                                type: integer
                                format: int
                                example: 1
                            name:
                                type: string
                                format: string
                                example: "STUDENT"

        Generate-Openemis-Id:
            type: "object"
            properties:
                message:
                    type: string
                    format: varchar
                    example: "Openemis Id Generated."
                data:
                    type: array
                    items:
                        type: object
                        properties:
                            openemis_no:
                                type: integer
                                format: int
                                example: 2382818281

        Generate-Password:
            type: "object"
            properties:
                message:
                    type: string
                    format: varchar
                    example: "Password is generated."
                data:
                    type: array
                    items:
                        type: object
                        properties:
                            password:
                                type: string
                                format: string
                                example: "cwxbdi"

        Contact-Types:
            type: "object"
            properties:
                message:
                    type: string
                    format: varchar
                    example: "Contact Type List Found."
                data:
                    type: array
                    items:
                        type: object
                        properties:
                            id:
                                type: integer
                                format: int
                                example: "1"
                            name:
                                type: string
                                format: string
                                example: "Personal"

        Staff-Custom-Fields:
            type: "object"
            properties:
                message:
                    type: string
                    format: varchar
                    example: "Staff Custom Fields List Found."
                data:
                    type: array
                    items: {}

        Field-Options:
            type: "object"
            properties:
                message:
                    type: string
                    format: varchar
                    example: "Field Option List Found."
                data:
                    type: array
                    items:
                        type: object
                        properties:
                            id:
                                type: integer
                                format: int
                                example: 1
                            name:
                                type: string
                                format: string
                                example: "Localities"
                            category:
                                type: string
                                format: string
                                example: "Institution"
                            table_name:
                                type: string
                                format: string
                                example: "table_name"
                            order:
                                type: integer
                                format: int
                                example: 1
                            modified_by:
                                type: integer
                                format: int
                                example: Null
                            modified:
                                type: string
                                format: string
                                example: Null
                            created_by:
                                type: integer
                                format: int
                                example: 2
                            created:
                                type: string
                                format: string
                                example: "2023-05-09 12:00:00"

        Field-Option-Data:
            type: "object"
            properties:
                message:
                    type: string
                    format: varchar
                    example: "Field Option Data Found."
                data:
                    type: array
                    items:
                        type: object
                        properties:
                            id:
                                type: integer
                                format: int
                                example: 1
                            name:
                                type: string
                                format: string
                                example: "Localities"
                            category:
                                type: string
                                format: string
                                example: "Institution"
                            table_name:
                                type: string
                                format: string
                                example: "table_name"
                            order:
                                type: integer
                                format: int
                                example: 1
                            modified_by:
                                type: integer
                                format: int
                                example: Null
                            modified:
                                type: string
                                format: string
                                example: Null
                            created_by:
                                type: integer
                                format: int
                                example: 2
                            created:
                                type: string
                                format: string
                                example: "2023-05-09 12:00:00"

        Basic-Information:
            type: "object"
            properties:
                message:
                    type: string
                    format: varchar
                    example: "User Data Found."
                data:
                    type: array
                    items: {}

        Relationship-Types:
            type: "object"
            properties:
                message:
                    type: string
                    format: varchar
                    example: "Relationship Types Found."
                data:
                    type: array
                    items:
                        type: object
                        properties:
                            id:
                                type: integer
                                format: int
                                example: 647
                            name:
                                type: string
                                format: string
                                example: "Mother"
                            gender_id:
                                type: integer
                                format: int
                                example: 2
                            order:
                                type: integer
                                format: int
                                example: 1
                            visible:
                                type: integer
                                format: int
                                example: 1
                            editable:
                                type: integer
                                format: int
                                example: 1
                            default:
                                type: integer
                                format: int
                                example: 0
                            international_code:
                                type: string
                                format: string
                                example: ""
                            national_code:
                                type: string
                                format: string
                                example: ""
                            modified_by:
                                type: integer
                                format: int
                                example: Null
                            modified:
                                type: string
                                format: string
                                example: Null
                            created_by:
                                type: integer
                                format: int
                                example: 2
                            created:
                                type: string
                                format: string
                                example: "2015-09-16 07:58:57"

        Staff-Types:
            type: "object"
            properties:
                message:
                    type: string
                    format: varchar
                    example: "Staff Types Found."
                data:
                    type: array
                    items:
                        type: object
                        properties:
                            id:
                                type: integer
                                format: int
                                example: 3
                            name:
                                type: string
                                format: string
                                example: "Permanent"
                            order:
                                type: integer
                                format: int
                                example: 1
                            modified_by:
                                type: integer
                                format: int
                                example: Null
                            modified:
                                type: string
                                format: string
                                example: Null
                            created_by:
                                type: integer
                                format: int
                                example: 2
                            created:
                                type: string
                                format: string
                                example: "2023-05-09 12:00:00"

        #POCOR-8104 Ends

        #POCOR-8078 Start
        Meal-Programme-Data:
            type: "object"
            properties:
                message:
                    type: string
                    format: varchar
                    example: "Meal Programme Data Found."
                data:
                    type: array
                    items:
                        type: object
                        properties:
                            id:
                                type: integer
                                format: int
                                example: 1
                            academic_period_id:
                                type: integer
                                format: int
                                example: 30
                            name:
                                type: string
                                format: string
                                example: "National Meal Programme"
                            code:
                                type: string
                                format: string
                                example: "NMP"
                            targeting:
                                type: integer
                                format: int
                                example: 1
                            implementer:
                                type: integer
                                format: int
                                example: 1
                            amount:
                                type: integer
                                format: int
                                example: 10.00
                            start_date:
                                type: string
                                format: string
                                example: "2021-01-01"
                            end_date:
                                type: string
                                format: string
                                example: "2021-12-31"
                            modified_user_id:
                                type: integer
                                format: int
                                example: Null
                            modified:
                                type: string
                                format: string
                                example: Null
                            created_user_id:
                                type: integer
                                format: int
                                example: 2
                            created:
                                type: string
                                format: string
                                example: "2021-03-22 08:43:37"

        Meal-Targets:
            type: "object"
            properties:
                message:
                    type: string
                    format: varchar
                    example: "Meal Targets List Found."
                data:
                    type: array
                    items:
                        type: object
                        properties:
                            id:
                                type: integer
                                format: int
                                example: 1
                            name:
                                type: string
                                format: string
                                example: "Individual"
                            order:
                                type: integer
                                format: int
                                example: 1
                            visible:
                                type: integer
                                format: int
                                example: 1
                            default:
                                type: integer
                                format: int
                                example: 0
                            international_code:
                                type: string
                                format: string
                                example: Null
                            national_code:
                                type: string
                                format: string
                                example: Null
                            modified_user_id:
                                type: integer
                                format: int
                                example: Null
                            modified:
                                type: string
                                format: string
                                example: Null
                            created_user_id:
                                type: integer
                                format: int
                                example: 1
                            created:
                                type: string
                                format: string
                                example: "2021-01-29 18:57:08"

        Meal-Implementers:
            type: "object"
            properties:
                message:
                    type: string
                    format: varchar
                    example: "Meal Implementers List Found."
                data:
                    type: array
                    items:
                        type: object
                        properties:
                            id:
                                type: integer
                                format: int
                                example: 1
                            name:
                                type: string
                                format: string
                                example: "Government"
                            order:
                                type: integer
                                format: int
                                example: 1
                            visible:
                                type: integer
                                format: int
                                example: 1
                            default:
                                type: integer
                                format: int
                                example: 0
                            international_code:
                                type: string
                                format: string
                                example: Null
                            national_code:
                                type: string
                                format: string
                                example: Null
                            modified_user_id:
                                type: integer
                                format: int
                                example: Null
                            modified:
                                type: string
                                format: string
                                example: Null
                            created_user_id:
                                type: integer
                                format: int
                                example: 1
                            created:
                                type: string
                                format: string
                                example: "2021-01-29 18:57:08"

        Meal-Nutritions:
            type: "object"
            properties:
                message:
                    type: string
                    format: varchar
                    example: "Meal Nutritions List Found."
                data:
                    type: array
                    items:
                        type: object
                        properties:
                            id:
                                type: integer
                                format: int
                                example: 1
                            name:
                                type: string
                                format: string
                                example: "Energy"
                            order:
                                type: integer
                                format: int
                                example: 1
                            visible:
                                type: integer
                                format: int
                                example: 1
                            default:
                                type: integer
                                format: int
                                example: 0
                            international_code:
                                type: string
                                format: string
                                example: Null
                            national_code:
                                type: string
                                format: string
                                example: Null

        Meal-Ratings:
            type: "object"
            properties:
                message:
                    type: string
                    format: varchar
                    example: "Meal Ratings List Found."
                data:
                    type: array
                    items:
                        type: object
                        properties:
                            id:
                                type: integer
                                format: int
                                example: 1
                            name:
                                type: string
                                format: string
                                example: 1
                            order:
                                type: integer
                                format: int
                                example: 1
                            visible:
                                type: integer
                                format: int
                                example: 1
                            default:
                                type: integer
                                format: int
                                example: 0
                            international_code:
                                type: string
                                format: string
                                example: Null
                            national_code:
                                type: string
                                format: string
                                example: Null

        Meal-Status:
            type: "object"
            properties:
                message:
                    type: string
                    format: varchar
                    example: "Meal Status Types List Found."
                data:
                    type: array
                    items:
                        type: object
                        properties:
                            id:
                                type: integer
                                format: int
                                example: 1
                            name:
                                type: string
                                format: string
                                example: "On Time"
                            order:
                                type: integer
                                format: int
                                example: 1
                            visible:
                                type: integer
                                format: int
                                example: 1
                            default:
                                type: integer
                                format: int
                                example: 0
                            international_code:
                                type: string
                                format: string
                                example: Null
                            national_code:
                                type: string
                                format: string
                                example: Null
                            modified_user_id:
                                type: integer
                                format: int
                                example: Null
                            modified:
                                type: string
                                format: string
                                example: Null
                            created_user_id:
                                type: integer
                                format: int
                                example: 1
                            created:
                                type: string
                                format: string
                                example: "2021-01-29 18:57:08"

        Meal-Food-Types:
            type: "object"
            properties:
                message:
                    type: string
                    format: varchar
                    example: "Meal Food Types List Found."
                data:
                    type: array
                    items:
                        type: object
                        properties:
                            id:
                                type: integer
                                format: int
                                example: 1
                            name:
                                type: string
                                format: string
                                example: "Vegetable"
                            order:
                                type: integer
                                format: int
                                example: 1
                            visible:
                                type: integer
                                format: int
                                example: 1
                            editable:
                                type: integer
                                format: int
                                example: 1
                            default:
                                type: integer
                                format: int
                                example: 0
                            international_code:
                                type: string
                                format: string
                                example: Null
                            national_code:
                                type: string
                                format: string
                                example: Null
                            modified_user_id:
                                type: integer
                                format: int
                                example: Null
                            modified:
                                type: string
                                format: string
                                example: Null
                            created_user_id:
                                type: integer
                                format: int
                                example: 1
                            created:
                                type: string
                                format: string
                                example: "2021-01-29 18:57:08"
        #POCOR-8078 Ends

        #POCOR-8153 Starts
        System-Configurations:
            type: "object"
            properties:
                message:
                    type: string
                    format: varchar
                    example: "System Configurations List Found."
                data:
                    type: array
                    items:
                        type: object
                        properties:
                            id:
                                type: integer
                                format: int
                                example: 1
                            name:
                                type: string
                                format: string
                                example: "Database Version"
                            code:
                                type: string
                                format: string
                                example: "db_version"
                            type:
                                type: string
                                format: string
                                example: "System"
                            label:
                                type: string
                                format: string
                                example: "Database Version"
                            value:
                                type: string
                                format: string
                                example: "3.99.1"
                            value_selection:
                                type: string
                                format: string
                                example: Null
                            default_value:
                                type: string
                                format: string
                                example: "1.0"
                            editable:
                                type: integer
                                format: int
                                example: 0
                            visible:
                                type: integer
                                format: int
                                example: 0
                            field_type:
                                type: string
                                format: string
                                example: ""
                            option_type:
                                type: string
                                format: string
                                example: ""
                            modified_user_id:
                                type: integer
                                format: int
                                example: 1
                            modified:
                                type: string
                                format: string
                                example: "2013-12-12 13:56:00"
                            created_user_id:
                                type: integer
                                format: int
                                example: 1
                            created:
                                type: string
                                format: string
                                example: "2013-12-12 13:56:00"
        #POCOR-8153 Ends

        #POCOR-8197 Starts
        Institution-Grades-List:
            type: "object"
            properties:
                message:
                    type: string
                    format: varchar
                    example: "Institution Grades List Found."
                data:
                    type: array
                    items:
                        type: object
                        properties:
                            id:
                                type: integer
                                format: int
                                example: 195
                            code:
                                type: string
                                format: string
                                example: "Lower Secondary 1"
                            name:
                                type: string
                                format: string
                                example: "Lower Secondary 1"
                            admission_age:
                                type: integer
                                format: int
                                example: 13
                            order:
                                type: integer
                                format: int
                                example: 1
                            visible:
                                type: integer
                                format: int
                                example: 1
                            education_stage_id:
                                type: integer
                                format: int
                                example: 7
                            education_programme_id:
                                type: integer
                                format: int
                                example: 7
                            modified_user_id:
                                type: integer
                                format: int
                                example: Null
                            modified:
                                type: string
                                format: string
                                example: Null
                            created_user_id:
                                type: integer
                                format: int
                                example: 7
                            created:
                                type: string
                                format: string
                                example: "2023-01-03 16:05:56"
        #POCOR-8197 Ends

        #POCOR-8206 Starts
        Academic-Periods:
            type: "object"
            properties:
                message:
                    type: string
                    format: varchar
                    example: "Academic Periods List Found."
                data:
                    type: array
                    items:
                        type: object
                        properties:
                            id:
                                type: integer
                                format: int
                                example: 33
                            code:
                                type: string
                                format: string
                                example: "YR2024"
                            name:
                                type: string
                                format: string
                                example: "2024"
                            start_date:
                                type: string
                                format: string
                                example: "2024-01-01"
                            start_year:
                                type: string
                                format: string
                                example: "2024"
                            end_date:
                                type: string
                                format: string
                                example: "2024-12-31"
                            end_year:
                                type: string
                                format: string
                                example: "2024"
                            school_days:
                                type: integer
                                format: int
                                example: 0
                            current:
                                type: integer
                                format: int
                                example: 1
                            editable:
                                type: integer
                                format: int
                                example: 1
                            parent_id:
                                type: integer
                                format: int
                                example: 9
                            lft:
                                type: integer
                                format: int
                                example: 34
                            rght:
                                type: integer
                                format: int
                                example: 35
                            academic_period_level_id:
                                type: integer
                                format: int
                                example: 1
                            order:
                                type: integer
                                format: int
                                example: 2
                            visible:
                                type: integer
                                format: int
                                example: 1
                            modified_user_id:
                                type: integer
                                format: int
                                example: 2
                            modified:
                                type: string
                                format: str
                                example: "2024-01-03 14:50:48"
                            created_user_id:
                                type: integer
                                format: int
                                example: 2
                            created:
                                type: string
                                format: str
                                example: "2024-01-03 14:50:48"

        Academic-Periods-List:
            type: "object"
            properties:
                message:
                    type: string
                    format: varchar
                    example: "Academic Periods List Found."
                data:
                    type: array
                    items:
                        type: object
                        properties:
                            id:
                                type: integer
                                format: int
                                example: 33
                            name:
                                type: string
                                format: string
                                example: "2024"
        #POCOR-8206 Ends

        #POCOR-8076 start
        centre-examination-subject:
            type: "object"
            properties:
                message:
                    type: string
                    example: Successful
                data:
                    type: array
                    items:
                        type: object
                        properties:
                            id:
                                type: string
                                example: e86f78917e4495b94808d1dc0b3a109ad43df082f3080199cd9cc8c2dab69955
                            created:
                                type: string
                                format: date-time
                                example: "2023-01-03 09:41:45"
                            education_subject_id:
                                type: integer
                                example: 60
                            examination_centre_id:
                                type: integer
                                example: 23
                            examination_id:
                                type: integer
                                example: 3
                            examination_subject_id:
                                type: integer
                                example: 10
                            education_subject:
                                type: object
                                properties:
                                    id:
                                        type: integer
                                        example: 60
                                    name:
                                        type: string
                                        example: Social Studies
                                    code:
                                        type: string
                                        example: SSMC
                                    order:
                                        type: integer
                                        example: 2
                                    visible:
                                        type: integer
                                        example: 1
                                    modified_user_id:
                                        type: integer
                                        example: 2
                                    modified:
                                        type: string
                                        format: date-time
                                        example: "2023-04-03 10:11:23"
                                    created_user_id:
                                        type: integer
                                        example: 1
                                    created:
                                        type: string
                                        format: date-time
                                        example: "2014-09-26 12:25:04"
                            examination_subject:
                                type: object
                                properties:
                                    id:
                                        type: integer
                                        example: 10
                                    name:
                                        type: string
                                        example: Social Studies
                                    code:
                                        type: string
                                        example: SST
                                    weight:
                                        type: string
                                        example: "0.25"
                                    examination_date:
                                        type: string
                                        format: date
                                        example: "2023-12-01"
                                    start_time:
                                        type: string
                                        example: "13:00:00"
                                    end_time:
                                        type: string
                                        example: "14:00:00"
                                    examination_grading_type_id:
                                        type: integer
                                        example: 1
                                    modified_user_id:
                                        type: integer
                                        example: 2
                                    modified:
                                        type: string
                                        format: date-time
                                        example: "2023-01-03 17:42:35"
                                    created_user_id:
                                        type: integer
                                        example: 2
                                    created:
                                        type: string
                                        format: date-time
                                        example: "2023-01-03 17:39:42"
                                    grading_type:
                                        type: object
                                        properties:
                                            id:
                                                type: integer
                                                example: 1
                                            code:
                                                type: string
                                                example: PSLE-GD
                                            name:
                                                type: string
                                                example: PSLE Gradings
                                            pass_mark:
                                                type: string
                                                example: "50.00"
                                            max:
                                                type: string
                                                example: "100.00"
                                            result_type:
                                                type: string
                                                example: MARKS
                                            visible:
                                                type: integer
                                                example: 1
                                            grading_options:
                                                type: array
                                                items:
                                                    type: object
                                                    properties:
                                                        id:
                                                            type: integer
                                                            example: 1
                                                        code:
                                                            type: string
                                                            example: A
                                                        name:
                                                            type: string
                                                            example: A
                                                        description:
                                                            type: string
                                                            example: ""
                                                        min:
                                                            type: string
                                                            example: "80.00"
                                                        max:
                                                            type: string
                                                            example: "100.00"
                                                        order:
                                                            type: integer
                                                            example: 1
                                                        visible:
                                                            type: integer
                                                            example: 1
                                                        examination_grading_type_id:
                                                            type: integer
                                                            example: 1
                                                        modified_user_id:
                                                            type: integer
                                                            example: null
                                                        modified:
                                                            type: string
                                                            example: null
                                                        created_user_id:
                                                            type: integer
                                                            example: 2
                                                        created:
                                                            type: string
                                                            example: "2020-03-06 05:07:42"

        centre-examination-subject-students:
            type: object
            properties:
                message:
                    type: string
                    example: Successful
                data:
                    type: array
                    items:
                        type: object
                        properties:
                            student_id:
                                type: integer
                                example: 1133
                            registration_number:
                                type: string
                                example: ""
                            institution_id:
                                type: integer
                                example: 6
                            academic_period_id:
                                type: integer
                                example: 32
                            total_mark:
                                type: integer
                                example: 32
                            result_marks:
                                type: integer
                                example: 32
                            result_id:
                                type: integer
                                example: 32
                            examination_grading_option_id:
                                type: integer
                                example: 3
                            first_name:
                                type: string
                                example: Laura
                            last_name:
                                type: string
                                example: Taube
                            third_name:
                                type: string
                                example: Taube
                            middle_name:
                                type: string
                                example: Taube
                            openemis_no:
                                type: string
                                example: "1522412898"

        centre-examination-subject-student-result:
            type: object
            properties:
                message:
                    type: string
                    example: Successful
                data:
                    type: array
                    items:
                        type: object
                        properties:
                            id:
                                type: string
                                example: "8ec5e06761cb0fde451f7bbe83523da07b17a1e280f310f3fb3a018c2d91854b"
                            marks:
                                type: string
                                description: The marks obtained by the student
                                example: "56"
                            examination_grading_option_id:
                                type: integer
                                description: The ID of the grading option used for the examination
                                example: 3
                            academic_period_id:
                                type: integer
                                description: The ID of the academic period
                                example: 32
                            examination_id:
                                type: integer
                                description: The ID of the examination
                                example: 3
                            education_subject_id:
                                type: integer
                                description: The ID of the education subject
                                example: 60
                            examination_subject_id:
                                type: integer
                                description: The ID of the examination subject
                                example: 10
                            examination_centre_id:
                                type: integer
                                description: The ID of the examination centre
                                example: 23
                            institution_id:
                                type: string
                                description: The ID of the institution
                                example: "6"
                            student_id:
                                type: integer
                                description: The ID of the student
                                example: 10530

        #POCOR-8076 ends
